Get organization of a user

The endpoint provides detailed information of an organization of a user.

HTTP request

GET https://$instanceId.id.nevis.cloud/nevis/api/v1/users/$userId/organization

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

userId=your-user-id-123

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

HTTP response

On success

HTTP/1.1 200 is returned if the organization is found for the user.

Parameter	Type	Description
version	integer	The version of the organization data, used for optimistic locking
created	string	The creation date of the organization in ISO 8061 timestamp format YYYY-MM-DDThh:mm:ssZ
lastModified	string	The last modification date of the organization modification in ISO 8061 timestamp format YYYY-MM-DDThh:mm:ssZ
organizationId	string	The identifier of the organization
domain	string	The domain of the organization
name	string	The name of the organization
organizationState	string	The state of the organization Values: active, blocked

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-08T10:17:29Z",
    "version": 0
}

On missing user

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

On user not assigned to an organization

HTTP/1.1 404 is returned if the user with the given userId is not assigned to an organization.

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 occurrs.