Get access app

The endpoint provides functionality to get the access app for existing users.

HTTP request

GET https://$instanceId.id.nevis.cloud/nevis/api/v1/users/$userId/access-apps/$accessAppId

Parameters

Parameter	In	Type	Required / Optional	Description
instanceId	path	string	required	The ID of your Identity Cloud instance
userId	path	string	required	The ID of the user
accessAppId	path	string	required	The ID of the access app

Example request

Set the ID of the user.

userId=your-user-id-123
accessAppId=your-access-app-id-123

curl --request GET "https://$instanceId.id.nevis.cloud/nevis/api/v1/users/$userId/access-apps/$accessAppId" \
  --header "Authorization: Bearer $accessKey"

HTTP response

On success

HTTP/1.1 200 is returned on success.

Parameter	Type	Description
stateName	enum	The state of the access app; Value: active
accessAppId	string	Unique identifier of this access app
created	string	The date of the access app creation
name	string	Name of the access app
lastModified	string	The date of the last access app modification; Initially equals the creation date
type	enum	The mobile platform of access app; Values: ios, android
userId	string	The ID of the user to whom the access app belongs to

Example response

{
  "stateName": "active",
  "accessAppId": "513a1116-46b8-4772-97bc-74dd506c2a4c",
  "created": "2023-04-04T05:03:07Z",
  "name": "samsung SM-G991B Apr 3, 2023 1:46:10 PM",
  "lastModified": "2023-04-04T05:03:07Z",
  "type": "android",
  "userId": "7de3aea8-acd6-463f-a13c-e44ce12658f5"
}

On missing user

HTTP/1.1 404 is returned with an error message if the user with the given userId is not found.

Example response

{
    "error": "User with id: 7de3aea8-acd6-463f-a13c-e44ce12658f5 cannot be found."
}

On missing access app

HTTP/1.1 404 is returned with an error message if the user with the given userId is not found.

Example response

{
    "error": "Access app with id: 513a1116-46b8-4772-97bc-74dd506c2a4c cannot be found."
}

On failure

HTTP/1.1 401 is returned if the authorization fails due to an invalid access key.

HTTP/1.1 500 is returned if an unexpected error occurs.