An example of using Cloud Administration User Details API with RSA IDPlus Admin Rest API
7 days ago
Article Number
000073702
Applies To

RSA Product Set:  SecurID Access
RSA Product/Service Type:  Cloud Access Service (CAS)/IDPlus Admin Rest API

Issue

There are no examples of using RSA IDPlus Admin Rest API with an OAuth client for looking up user data.

Tasks

An OAuth client (Client Type: Admin API) has already been defined in CAS. 

Refer to Manage OAuth API Clients at https://community.rsa.com/s/article/Manage-OAuth-API-Clients-ef26333a


An example of Authentication:

 

An example of Permissions:

Resolution

Developers can refer to Authentication for the Cloud Administration APIs at URL https://community.securid.com/s/article/Authentication-for-the-Cloud-Administration-APIs-a04e3fb9 for generating OAuth credentials. To generate OAuth credentials for your client, you must first build a client assertion as a signed JSON Web Token (JWT) and send it to CAS. CAS (acting as an OAuth authorization server) will generate and return an access token to the client. The access token can be reused in multiple Admin API requests, until it expires. 

 

The following are examples of using curl, Postman and Talend API tester to retrieve user data where an access token has been generated.


Template of curl Command

curl --header "Content-Type: application/json" --header "Authorization: Bearer <access token>" --url https://tenantname/AdminInterface/restapi/v1/users/lookup --data "{\"email\":\"user@domain.suffix\",\"searchUnsynched\":\"false\"}"

 

Example of curl Command

curl --header "Content-Type: application/json" --header "Authorization: Bearer eyJraWQiOiIyOTQwMjkxOTgyODE0OTYwODg0NzAyNDQxMjYyMDc4Mjg1MDc0ODA4NDI2NzU3MDgiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI1MGYyNDQyNS01Y2MyLTRmMmMtYmE2Mi0wNzgyODU2ZmQzY2QiLCJhdWQiOlsiaHR0cHM6Ly9nczgyLmFjY2Vzcy1kZW1vLnNlY3VyaWQuY29tIiwiaHR0cHM6Ly9nczgyLmF1dGgtZGVtby5zZWN1cmlkLmNvbSJdLCJ2ZXIiOjEsInNjb3BlIjoicnNhLmF1ZGl0LmFkbWluIHJzYS51c2VyLnJlYWQiLCJpc3MiOiJodHRwczovL2dzODIuYXV0aC1kZW1vLnNlY3VyaWQuY29tL29hdXRoIiwiZXhwIjoxNzYzMzQxMzY3LCJpYXQiOjE3NjMzMzk1MDcsImp0aSI6IjIwMDgwODk2MzUifQ.X84iSNbGj7R9YXtOJOzWiVlMpAzWjjnnC6kI697K78RFIL3DTJrqV49GRh9T482r0w5s9DWcHAKwaE2_44ZLYORuoNBlaewdruYvBUODTqgQpvqP5ch7masrEoD6ijUGvMaZwM_jiB4cSbgyEvE6GffHNWoNHAPm_vOgXa1psLg1yRuL6GxUVXmKgANdsuUZgLQKIwPr6WP4yYo7a_1_MJxYBta24P6VR5mvhkiOdQsOmBqE49P_4J_warIGXoYH-OCsvbWG4K86yNAGw_S2ZKLzEIUFOzgcl3UN9AqB-yrdT40YetLscOd7BLQAAT5mJ3odkK_tVZJy8_vUxkoCXw" --url https://gs82.access-demo.securid.com/AdminInterface/restapi/v1/users/lookup --data "{\"email\":\"mbell@securidcsapj.local\",\"searchUnsynched\":\"false\"}"

 

Response

{"id":"7616b2b7-63c6-43c1-801c-1271e9cbd4ac","emailAddress":"mbell@securidcsapj.local","firstName":"Mark","lastName":"Bell","creationDate":"2022-08-01T23:35:21.000Z","identitySource":"securidcsapj.local","userStatus":"Enabled","highRiskUser":false,"markDeleted":false,"markDeletedAt":null,"markDeletedBy":null,"smsNumber":null,"voiceNumber":null,"isTokenLocked":false,"isSmsLocked":false,"isVoiceLocked":false,"isFingerprintLocked":false,"isApproveLocked":false,"lastSyncTime":"2025-11-03T03:54:16.000Z","emergencyAccessStatus":"Disabled","emergencyTokencodeId":null,"emergencyTokencodeExpiration":null,"emergencyTokencodeLastUse":null,"emergencyTokencodeOneTimeUse":null,"offlineEmergencyTokencodeExpiration":null,"offlineEmergencyAccessStatus":"Disabled","monthLastAuthenticated":"Nov 2025","principalUsername":"mbell","alternateUsername":"","primaryUniqueIdentifier":"CN=Mark Bell,OU=People,OU=APJ,OU=RSA Customer Support,DC=securidcsapj,DC=local","lastSuccessfulAuthenticationMethod":null,"lastSuccessfulAuthenticationDate":null}

 

Postman configuration

POST 
https://gs82.access-demo.securid.com/AdminInterface/restapi/v1/users/lookup

 

Authorization:

Bearer Token <Token Value>


Headers:

 

Content-Type application/json

 

Body:

 

{
  "email":"mbell@securidcsapj.local",
  "searchUnsynched":"false"
}

Response:

 

{
    "id": "7616b2b7-63c6-43c1-801c-1271e9cbd4ac",
    "emailAddress": "mbell@securidcsapj.local",
    "firstName": "Mark",
    "lastName": "Bell",
    "creationDate": "2022-08-01T23:35:21.000Z",
    "identitySource": "securidcsapj.local",
    "userStatus": "Enabled",
    "highRiskUser": false,
    "markDeleted": false,
    "markDeletedAt": null,
    "markDeletedBy": null,
    "smsNumber": null,
    "voiceNumber": null,
    "isTokenLocked": false,
    "isSmsLocked": false,
    "isVoiceLocked": false,
    "isFingerprintLocked": false,
    "isApproveLocked": false,
    "lastSyncTime": "2025-11-03T03:54:16.000Z",
    "emergencyAccessStatus": "Disabled",
    "emergencyTokencodeId": null,
    "emergencyTokencodeExpiration": null,
    "emergencyTokencodeLastUse": null,
    "emergencyTokencodeOneTimeUse": null,
    "offlineEmergencyTokencodeExpiration": null,
    "offlineEmergencyAccessStatus": "Disabled",
    "monthLastAuthenticated": "Nov 2025",
    "principalUsername": "mbell",
    "alternateUsername": "",
    "primaryUniqueIdentifier": "CN=Mark Bell,OU=People,OU=APJ,OU=RSA Customer Support,DC=securidcsapj,DC=local",
    "lastSuccessfulAuthenticationMethod": null,
    "lastSuccessfulAuthenticationDate": null
}

 

Talend API Tester configuration

 

POST 
https://gs82.access-demo.securid.com/AdminInterface/restapi/v1/users/lookup

HEADERS
Authorization Bearer eyJraWQiOiIyOTQwMjkxOTgyODE0OTYwODg0NzAyNDQxMjYyMDc4Mjg1MDc0ODA4NDI2NzU3MDgiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI1MGYyNDQyNS01Y2MyLTRmMmMtYmE2Mi0wNzgyODU2ZmQzY2QiLCJhdWQiOlsiaHR0cHM6Ly9nczgyLmFjY2Vzcy1kZW1vLnNlY3VyaWQuY29tIiwiaHR0cHM6Ly9nczgyLmF1dGgtZGVtby5zZWN1cmlkLmNvbSJdLCJ2ZXIiOjEsInNjb3BlIjoicnNhLmF1ZGl0LmFkbWluIHJzYS51c2VyLnJlYWQiLCJpc3MiOiJodHRwczovL2dzODIuYXV0aC1kZW1vLnNlY3VyaWQuY29tL29hdXRoIiwiZXhwIjoxNzYzMzM1NjQxLCJpYXQiOjE3NjMzMzM3ODEsImp0aSI6IjM2NTA1MjU1MiJ9.DUYDFthgKzb3qwCTlKfB3YIYYe4rKzfpTSTomDXgXApz8cbvIH6mBgE-wTAjig2oHkWy72whGgU1Np9ITwi9nhnfg-5zZubodQL7yqHwgNBAOEw71-3dx-5yLdLSz66WbOtEueVcDS6lqVnwQYTyaE3L_tPrtz_TFKufr6WIb6_bA_kYChweC7KtL95tcBcJX8CTtux-QJc7e1FP8Up8w51mr8peb0MXMvTnvf4qOnbfHEsRIpokRfXffwMelp4PVa-N9mhEMtTeF5UZgaqMondmz8suswKGWqH7rdQKXKZqhdYxruM8swikdjQryPN5tyu-syGrrVLYwA7mcV_CqA
Content-Type application/json

BODY
{
  "email":"mbell@securidcsapj.local",
  "searchUnsynched":"false"
}

 

Response:

 

 

POST /AdminInterface/restapi/v1/users/lookup HTTP/1.1
Authorization: Bearer eyJraWQiOiIyOTQwMjkxOTgyODE0OTYwODg0NzAyNDQxMjYyMDc4Mjg1MDc0ODA4NDI2NzU3MDgiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI1MGYyNDQyNS01Y2MyLTRmMmMtYmE2Mi0wNzgyODU2ZmQzY2QiLCJhdWQiOlsiaHR0cHM6Ly9nczgyLmFjY2Vzcy1kZW1vLnNlY3VyaWQuY29tIiwiaHR0cHM6Ly9nczgyLmF1dGgtZGVtby5zZWN1cmlkLmNvbSJdLCJ2ZXIiOjEsInNjb3BlIjoicnNhLmF1ZGl0LmFkbWluIHJzYS51c2VyLnJlYWQiLCJpc3MiOiJodHRwczovL2dzODIuYXV0aC1kZW1vLnNlY3VyaWQuY29tL29hdXRoIiwiZXhwIjoxNzYzMzM1NjQxLCJpYXQiOjE3NjMzMzM3ODEsImp0aSI6IjM2NTA1MjU1MiJ9.DUYDFthgKzb3qwCTlKfB3YIYYe4rKzfpTSTomDXgXApz8cbvIH6mBgE-wTAjig2oHkWy72whGgU1Np9ITwi9nhnfg-5zZubodQL7yqHwgNBAOEw71-3dx-5yLdLSz66WbOtEueVcDS6lqVnwQYTyaE3L_tPrtz_TFKufr6WIb6_bA_kYChweC7KtL95tcBcJX8CTtux-QJc7e1FP8Up8w51mr8peb0MXMvTnvf4qOnbfHEsRIpokRfXffwMelp4PVa-N9mhEMtTeF5UZgaqMondmz8suswKGWqH7rdQKXKZqhdYxruM8swikdjQryPN5tyu-syGrrVLYwA7mcV_CqA
Content-Length: 69
Content-Type: application/json
Host: gs82.access-demo.securid.com
{
  "email":"mbell@securidcsapj.local",
  "searchUnsynched":"false"
}

HTTP/1.1 200
Date: Sun, 16 Nov 2025 22:57:46 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 1033
Connection: keep-alive
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: SAMEORIGIN
Set-Cookie: JSESSIONID=NDQ2ZTdkMjAtNDI4OS00ZjUyLWIyYTEtNWUzMzE5OTYwMDk1; Path=/; Secure; HttpOnly; SameSite=None
{"id":"7616b2b7-63c6-43c1-801c-1271e9cbd4ac","emailAddress":"mbell@securidcsapj.local","firstName":"Mark","lastName":"Bell","creationDate":"2022-08-01T23:35:21.000Z","identitySource":"securidcsapj.local","userStatus":"Enabled","highRiskUser":false,"markDeleted":false,"markDeletedAt":null,"markDeletedBy":null,"smsNumber":null,"voiceNumber":null,"isTokenLocked":false,"isSmsLocked":false,"isVoiceLocked":false,"isFingerprintLocked":false,"isApproveLocked":false,"lastSyncTime":"2025-11-03T03:54:16.000Z","emergencyAccessStatus":"Disabled","emergencyTokencodeId":null,"emergencyTokencodeExpiration":null,"emergencyTokencodeLastUse":null,"emergencyTokencodeOneTimeUse":null,"offlineEmergencyTokencodeExpiration":null,"offlineEmergencyAccessStatus":"Disabled","monthLastAuthenticated":"Nov 2025","principalUsername":"mbell","alternateUsername":"","primaryUniqueIdentifier":"CN=Mark Bell,OU=People,OU=APJ,OU=RSA Customer Support,DC=securidcsapj,DC=local","lastSuccessfulAuthenticationMethod":null,"lastSuccessfulAuthenticationDate":null}