Update access app

The endpoint provides functionality to update the name of the access app of an existing user.

HTTP request

PATCH 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

Request body

Parameter	Type	Required / Optional	Description
name	string	required	The new name of the access app

Example request

Set the user ID and access app ID in the following snippet and type a new name value to be set.

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

curl --request PATCH "https://$instanceId.id.nevis.cloud/nevis/api/v1/users/$userId/access-apps/$accessAppId" \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer $accessKey" \
  --data "{ \"name\" : \"$name\" }"
  

HTTP response

On success

HTTP/1.1 200 is returned if the access app is successfully modified.

The response contains all the attributes of the 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
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": "be3927bb-3123-491f-a73a-3fab266d8650",
  "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": "d7e05c6c-af4e-4d67-806b-0601c12990cf"
}

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: d7e05c6c-af4e-4d67-806b-0601c12990cp cannot be found."
}

On missing access app

HTTP/1.1 404 is returned with an error message if an access app with the given accessAppId is not found.

Example response

{
    "error": "Access app with id: be3927bb-3123-491f-a73a-3fab266d8651 cannot be found."
}

On failure

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

HTTP/1.1 422 is returned if invalid request content is given.

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