Update organization

Request

Update an organization's basic configuration. This should be called from the backend, using an admin access token (generated by a management app).

Required permissions: organizations:edit, orgs:edit.

Security

AdminAccessToken

Path

organization_idstringrequired

ID of the organization to update

Bodyapplication/jsonrequired

namestring

Name of the organization

domainsArray of strings

Domains of the organization

enabledboolean

Indicates if the organization is currently enabled

alias_namestring

Alias name of the organization

domainstringdeprecated

Domain of the organization

curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/cis/v1/organizations/{organization_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "domain": "string",
    "domains": [
      "string"
    ],
    "enabled": true,
    "alias_name": "string"
  }'

Responses

Bodyapplication/json

resultobjectrequired

Response

{
  "result": {
    "organization_id": "string",
    "app_ids": [ … ],
    "name": "string",
    "domain": "string",
    "domains": [ … ],
    "created_at": 0,
    "updated_at": 0,
    "enabled": true,
    "managed_organizations_by_app": { … },
    "managing_organization_id": "string",
    "logo_url": "string",
    "alias_name": "string"
  }
}