Update organization

The endpoint provides functionality for organization modification.

HTTP request

PATCH https://$instanceId.id.nevis.cloud/nevis/api/v1/organizations/$organizationId

Parameters

Parameter	In	Type	Required / Optional	Description
instanceId	path	string	Required	The ID of your Identity Cloud instance
organizationId	path	string	Required	The ID of the organization
includeUserCount	query	boolean	Optional	If the value is true the number of users assigned to the organization is included in the response Default false

Request body

Parameter	Type	Required / Optional	Description
domain	string	Optional	The domain of the organization
name	string	Optional	The name of the organization
version	integer	Optional	The version of the organization data, used for optimistic locking
overrideLoginProvider	enum	Optional	Types of the login provider Values: none, google, microsoft, Default: none
overrideSignup	enum	Optional	Types of the signup override Values: none, disabled, default, custom, Default: none
customSignupUrl	enum	Optional	Url of the organization if the overrideSignup is custom

Example request

Modifying an organization's name

organizationId=your-organization-id-123
name=Your organization

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

HTTP response

On success

HTTP/1.1 200 is returned if the organization is successfully modified.

The response contains all attributes of the organization. The version and lastModified parameters are updated automatically.

Example response

{
    "organizationId": "4e71988b-7302-4133-adf8-887499357ad4",
    "created": "2023-06-08T10:17:29Z",
    "domain": "your-organization.org",
    "name": "Your Organization",
    "organizationState": "active",
    "lastModified": "2023-06-09T10:17:29Z",
    "version": 1,
    "userCount": 15,
    "overrideLoginProvider": "none",
    "overrideSignup": "none"
}

On failure

HTTP/1.1 404 is returned if no organization is found with the given organizationId, with a detailed message.

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

HTTP/1.1 409 is returned if update fails with conflict.

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

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