← Organization API

PUT/v1/organizations/{id}Update organization details

Change the details of an organization.
Only fields that are defined in the PUT method will be updated, all other fields will be be untouched. Setting a handshake can only by done by administrators, while setting a subscription can also by done by support. When a subscriptionId is provided, the caller must be support or the creator of at least one other organization with that subscription id. The organization's subscription/customer data is copied from a matching organization, and its permissions are replaced with the intersection of all matching organizations.
headerAuthorizationAuthentication token (bearer token or API key).
{
"name" : String,
"subscriptionId" : String,
"isSuperUser" : Boolean
}

Response

status200All ok
status400Invalid input
status401Invalid authentication token
status403Insufficient rights
status404No existing organizations found for this subscription
Number

Example: Update an organization as a user

PUT/v1/organizations/1

headerAuthorizationBearer 9fb599d8-ca2d-4085-95a3-09088eb3bded
{
"name": "Custom Name"
}

Response

status200
headerAccess-Control-Expose-Headersauthorization, content-type
headerAccess-Control-Allow-Headersauthorization, content-type
headerAccess-Control-Allow-MethodsGET, POST, DELETE, OPTIONS, PUT
headerAccess-Control-Allow-Origin*
headerStrict-Transport-Securitymax-age=31536000; includeSubDomains
headerX-Frame-OptionsSAMEORIGIN
headerX-Content-Type-Optionsnosniff
headerX-XSS-Protection1; mode=block
headerContent-Security-Policydefault-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
headerReferrer-Policyno-referrer
headerFeature-Policyself
headerPermissions-policyinterest-cohort=()
{
"id": 1
}

Example: Update an organization as a System Admin

PUT/v1/organizations/1

headerAuthorizationBearer 23319191-5a05-48f8-8019-a509d23d4ec0
{
"name": "Enterprise Org"
}

Response

status200
headerAccess-Control-Expose-Headersauthorization, content-type
headerAccess-Control-Allow-Headersauthorization, content-type
headerAccess-Control-Allow-MethodsGET, POST, DELETE, OPTIONS, PUT
headerAccess-Control-Allow-Origin*
headerStrict-Transport-Securitymax-age=31536000; includeSubDomains
headerX-Frame-OptionsSAMEORIGIN
headerX-Content-Type-Optionsnosniff
headerX-XSS-Protection1; mode=block
headerContent-Security-Policydefault-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
headerReferrer-Policyno-referrer
headerFeature-Policyself
headerPermissions-policyinterest-cohort=()
{
"id": 1
}

Example: Update an organization with subscriptionId (replaces permissions with intersection)

PUT/v1/organizations/1

headerAuthorizationBearer 94fd95b9-100f-4dd7-85df-43f082bc76e0
{
"subscriptionId": "sub-123"
}

Response

status200
headerAccess-Control-Expose-Headersauthorization, content-type
headerAccess-Control-Allow-Headersauthorization, content-type
headerAccess-Control-Allow-MethodsGET, POST, DELETE, OPTIONS, PUT
headerAccess-Control-Allow-Origin*
headerStrict-Transport-Securitymax-age=31536000; includeSubDomains
headerX-Frame-OptionsSAMEORIGIN
headerX-Content-Type-Optionsnosniff
headerX-XSS-Protection1; mode=block
headerContent-Security-Policydefault-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
headerReferrer-Policyno-referrer
headerFeature-Policyself
headerPermissions-policyinterest-cohort=()
{
"id": 1
}

Example: Reject a subscriptionId without another matching organization

PUT/v1/organizations/1

headerAuthorizationBearer 1498a8c5-d312-4fe0-8e77-603c6fd0dc36
{
"subscriptionId": "unknown-subscription"
}

Response

status404
headerAccess-Control-Expose-Headersauthorization, content-type
headerAccess-Control-Allow-Headersauthorization, content-type
headerAccess-Control-Allow-MethodsGET, POST, DELETE, OPTIONS, PUT
headerAccess-Control-Allow-Origin*
headerStrict-Transport-Securitymax-age=31536000; includeSubDomains
headerX-Frame-OptionsSAMEORIGIN
headerX-Content-Type-Optionsnosniff
headerX-XSS-Protection1; mode=block
headerContent-Security-Policydefault-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
headerReferrer-Policyno-referrer
headerFeature-Policyself
headerPermissions-policyinterest-cohort=()
{
"message": "No existing organizations found for this subscription",
"errorMessage": "No existing organizations found for this subscription"
}

Example: Allow the subscription creator to move an organization

PUT/v1/organizations/1

headerAuthorizationBearer 0229ce78-f2c3-4c5a-9219-3f73f550da46
{
"subscriptionId": "sub-123"
}

Response

status200
headerAccess-Control-Expose-Headersauthorization, content-type
headerAccess-Control-Allow-Headersauthorization, content-type
headerAccess-Control-Allow-MethodsGET, POST, DELETE, OPTIONS, PUT
headerAccess-Control-Allow-Origin*
headerStrict-Transport-Securitymax-age=31536000; includeSubDomains
headerX-Frame-OptionsSAMEORIGIN
headerX-Content-Type-Optionsnosniff
headerX-XSS-Protection1; mode=block
headerContent-Security-Policydefault-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
headerReferrer-Policyno-referrer
headerFeature-Policyself
headerPermissions-policyinterest-cohort=()
{
"id": 1
}

Example: Reject moving an organization by an account that does not own the subscription

PUT/v1/organizations/1

headerAuthorizationBearer 6e51280c-b3bf-425d-a47e-158247c20e7f
{
"subscriptionId": "sub-123"
}

Response

status403
headerAccess-Control-Expose-Headersauthorization, content-type
headerAccess-Control-Allow-Headersauthorization, content-type
headerAccess-Control-Allow-MethodsGET, POST, DELETE, OPTIONS, PUT
headerAccess-Control-Allow-Origin*
headerStrict-Transport-Securitymax-age=31536000; includeSubDomains
headerX-Frame-OptionsSAMEORIGIN
headerX-Content-Type-Optionsnosniff
headerX-XSS-Protection1; mode=block
headerContent-Security-Policydefault-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
headerReferrer-Policyno-referrer
headerFeature-Policyself
headerPermissions-policyinterest-cohort=()
{
"message": "The request was a legal request, but the server is refusing to respond to it.",
"errorMessage": "The request was a legal request, but the server is refusing to respond to it."
}