Update custom scope

The endpoint provides functionality to update a custom scope.

HTTP request

PATCH https://$instanceId.id.nevis.cloud/nevis/api/v1/scopes/$scopeId

Parameters

Parameter	In	Type	Required / Optional	Description
instanceId	path	string	required	The ID of your Identity Cloud instance
scopeId	path	string	required	The ID of the custom scope

Request body

Parameter	Type	Required / Optional	Description
name	string	Optional	The name of the custom scope. Constraint: The name must be unique, contain only alphanumeric characters and underscores, and have a maximum length of 30 characters.
description	string	Optional	The description of the custom scope. Constraint: The description must have a maximum length of 120 characters.

Example request

scopeId=your-custom-scope-id
name=your_custom_scope

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

HTTP response

On success

HTTP/1.1 200 is returned if the custom scope is successfully updated.

The response contains all attributes of the custom scope.

{
    "scopeId": "your-custom-scope-id",
    "name": "your_custom_scope",
    "description": "custom scope description"
}

On failure

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

HTTP/1.1 404 is returned if no custom scope is found with the given scopeId, with a detailed message.

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

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