Get organization

The endpoint provides detailed information of an organization.

HTTP request

GET 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

Example request

Set the ID of the organization.

organizationId=your-organization-id-123

curl "https://$instanceId.id.nevis.cloud/nevis/api/v1/organizations/$organizationId?includeUserCount=true" \
  --header "Authorization: Bearer $accessKey"

HTTP response

On success

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

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
userCount	integer	The number of the users assigned to the organization
overrideLoginProvider	enum	Types of the login provider Values: none, google, microsoft, Default: none
overrideSignup	enum	Types of the signup override Values: none, disabled, default, custom, Default: none
customSignupUrl	enum	Url of the organization if the overrideSignup is custom

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,
    "userCount": 15,
    "overrideLoginProvider": "none",
    "overrideSignup" : "none",
    "customSignupUrl": ""
}

On missing organization

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

Example response

{
    "errors": [
        {
            "code": "errors.noRecord",
            "message": "Organization with id: test-org 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.