Get access apps

The endpoint provides functionality to list access apps for an existing user.

HTTP request

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

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

Example request

Set the ID of the user.

userId=your-user-id-123

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

HTTP response

On success

HTTP/1.1 200 is returned on success.

Parameter	Type	Description
items	array of access apps	The collection of access apps

Access app

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

{
    "items": [
        {
          "stateName": "active",
          "accessAppId": "d5d6c663-26fe-4d0b-b123-2fad132b48cf",
          "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": "4a5e7346-488b-46f9-914f-79ddb1131e0b"
        }
    ]
}

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: cdc891da-51ea-11ec-bf63-0242ac130002 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.