If you're looking for a quick way to get started with the Identity Cloud REST APIs, you might want to download our new Postman Collection, something you can do by clicking the button below:
Clicking that button downloads a .ZIP file (identity-cloud-rest-apis-postman-collection.zip) that, in turn, contains these two files:
- Identity Cloud REST APIs.postman_collection.json. The Postman collection itself (including sample code and brief documentation for all the endpoints).
- Identity Cloud REST API Postman Environment.postman_environment.json. A Postman environment to accompany the collection.
Import those files into Postman and you're good to go.
A Note About the Postman Environment
The Postman environment is a list of variables representing values used repeatedly throughout the Postman collection; for example, instead of typing https://v1.api.us.janrain.com over and over again, you can simply enter https://v1.api.us.janrain.com as the value of the identityDomain variable. From that point on (as long as you're using the Identity Cloud environment, of course), Postman will automatically replace each instance of with https://v1.api.us.janrain.com.
Just keep in mind that the Postman environment you download will include all the variable names, but it won't have any of the variable values:
Why did we leave all those values blank? You got it: because we don't know your apiClientId or your apiKey. That's information you'll need to fill in yourself. (Or not: after all, you don't have to use the Postman environment.) If you aren't sure what goes where, the following table provides the name, a brief description, and a sample value for each variable in the Postman environment:
Access token required to call the OAuth/OpenID Connect APIs.
Unique identifier assigned to an API client. (In the Postman collection, this typically refers to a client with the login feature.) You can find the ID for a client by locating that client on Console’s Manage Properties page.
Unique identifier for your Social Login application. This the value assigned to the rpx_app_id setting on Console’s Manage Application page.
Unique identifier for your Identity Cloud application. You can find this value listed next to the Application Id header on Console’s Manage Application page.
Unique identifier of your configuration client. This value is used for the username setting when retrieving a configuration access token (adminAccessToken). To find this value, look for the confidential_client_id setting on Console’s Manage Application page.
Client secret for your configuration client. This value is used for the password setting when retrieving a configuration access token (adminAccessToken). To find this value, look for the confidential_client_secret setting on Console’s Manage Application page.
Your organization’s Akamai customer ID. This ID can be found on Console’s Manage Application page next to the customer_id label.
Unique identifier of an API client that has been assigned the direct_access feature. You can find the ID for a direct_access client by looking on Console’s Manage Properties page.
Client secret (i.e., password) assigned to an API client that has the direct_access feature. You can find the secret for a direct_access client by locating the client on Console’s Manage Properties page, clicking the Actions icon next to the client name, and then clicking Edit.
Name of the user profile database where your user accounts are stored. By default you are issued a single entity type: user. However, you can create additional entity types as needed.
API clients do not have to use the same entity type. To find the entity type assigned to a specific client, look for the user_entity_type setting in the API client’s General Settings section.
Name of the flow used by an API client. API clients do not have to use the same flow. To find the flow assigned to a specific client, look for the default_flow_name setting in the API client’s General Settings section.
Identifier (which is actually a timestamp) assigned to each version of a flow. You can find all the version numbers for a flow by using Console’s Registration Builder.
API clients do not have to use the same flow version. To find the version of the flow assigned to a specific client, look for the default_flow_version setting in the API Client’s General Settings section. The value HEAD indicates that the API client automatically uses the most-recent version of the flow.
Domain used when calling many of the Identity Cloud APIs.
Language/locale primarily used when rendering Identity Cloud screens. The default value (and the only language included "out of the box") is en-US: US English.
Unique identifier fir a Hosted Login login policy.
Unique identifier for an OpenID Connect client. All three client types used by Hosted Login – public, confidential, and configuration – have a client ID.
Client secret (i.e., password) assigned to an OpenID Connect client. Only configuration clients and confidential clients have client secrets.
Unique identifier of an API client that has been assigned the owner feature. You can find the ID for an owner client by looking on Console’s Manage Properties page.
Client secret (i.e., password) assigned to an API client that has the owner feature. You can find the secret for an owner client by locating the client on Console’s Manage Properties page, clicking the Actions icon next to the client name, and then clicking Edit.
Unique identifier of a custom provider. Custom providers are social login providers that are not predefined for you by Akamai.
Also referred to as the “Capture” domain. This is the value assigned to the Registration Domain(s) setting on Console’s Manage Application page. The registration domain is used when calling the Entity and Entity Type APIs; the Authentication APIs; and the Legacy Client and Settings APIs.
Unique identifier of a Social Login application. You can find the Social Login application ID on the Settings page in the Social Login Dashboard (look for the App ID value)
Domain used when calling the Social APIs. Your social login domain is the value assigned to the Application Domain setting in the Social Login dashboard).
Unique identifier of a Hosted Login token policy.
Access token issued to an individual user following a successful authentication.