Accessing the IDM REST APIs


You can use many, but not all, of the Identity Management APIs with Identity Cloud.

Before you can authenticate to the IDM API server, must first obtain an access token. The access token must include:

  • IDM admin privileges

  • The fr:idm:* scope

Getting a user access token

There are many different ways to get a user access token. One way is to use the Identity Cloud Postman collection.

  1. Follow the instructions for getting started with the Postman collection:

  2. In the Postman collection, click Prerequisites.

  3. To create an admin user and set the scope, complete Steps 1 through 3.

    Show me where

    postman admin user

  4. To generate a token, complete any one of flows in the OAuth 2.0 directory.

    Show me where

    postman oauth2 flows

Authenticate to the IDM API server

  1. Set a shell environment variable with your access token value.

    export TOKEN="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJkNWE4NDVjMy03MjFh
  2. Run a command like this example, replacing <tenant> with your tenant name:

    curl \
      -H 'authorization: Bearer '"$TOKEN" \
      --header "Accept-API-Version: resource=1.0" \
      --request POST \

    For a comprehensive list of IDM APIs, see the IDM REST API Explorer.

More information