GET /api/v1/realms

Lists all realms.

Note: The search parameter results are sourced from an eventually consistent datasource and may not reflect the latest information.

Servers

Query parameters

Name Type Required Description
sortOrder String No

Specifies sort order: asc or desc (for search queries only). This parameter is ignored if sortBy isn't present.

Default value: "asc"

limit Integer No

Specifies the number of results returned. Defaults to 10 if search is provided.

Default value: 200

sortBy String No

Specifies the field to sort by and can be any single property (for search queries only)

after String No

The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the Link response header. See Pagination and Link header.

search String No

Searches for realms with a supported filtering expression for most properties.

Searches for realms can be filtered by the contains (co) operator. You can only use co with the profile.name property. See Operators.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.