Create organization

The endpoint provides functionality to create an organization.

HTTP request

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

Parameters

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

Request body

An organization can be created by only providing the domain and name.

Parameter	Type	Required / Optional	Description
domain	string	Required	The domain of the organization
name	string	Required	The name of the organization
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

You need to provide the required domain and name.

domain=your-organization.org
name=Your organization

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

HTTP response

On success

HTTP/1.1 201 is returned if the organization is successfully created.

The response has the following additional header Location, containing the organizationId of the created organization:

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

The organizationId is a generated UUID.

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.