Identity Cloud

Specify realms in REST API calls

Realms can be specified in the following ways when making a REST API call to AM:

DNS alias

When making a REST API call, the DNS alias of a realm can be specified in the subdomain and domain name components of the REST endpoint.

To list all users in a realm with DNS alias suppliers.example.com the REST endpoint would be:

https://suppliers.example.com:8443/openam/json/users?_queryId=*
Path

When making a REST API call, specify the realm in the path component of the endpoint.

To authenticate a user in a subrealm named alpha, the REST endpoint would be:

https://<tenant-env-fqdn>/am/json/realms/root/realms/alpha/authenticate

If realms are specified using both the DNS alias and path methods, the path is used to determine the realm.

For example, the following REST endpoint returns users in a realm named bravo, not the realm with DNS alias suppliers.example.com:

https://suppliers.example.com:8443/openam/json/realms/root/realms/bravo/users?_queryId=*
Copyright © 2010-2022 ForgeRock, all rights reserved.