v1

latestOpenAPI 3.0.02026-07-142351,1971.3 MB

Organizations

Update your organization

Update your organization.

put/api/v1/org/{public_id}

Path parameters

public_idstring required

Example:abc123

The public_id of the organization you are operating within.

Request body

createdstring

Date of the organization creation.

descriptionstring

Description of the organization.

namestring

The name of the child organization, limited to 32 characters.

public_idstring

The public_id of the organization you are operating within.

trialboolean

Only available for MSP customers. Allows child organizations to be created on a trial plan.

Example request

{
  "billing": {
    "type": "parent_billing"
  },
  "created": "2019-09-26T17:28:28Z",
  "description": "some description",
  "name": "New child org",
  "public_id": "abcdef12345",
  "settings": {
    "saml_autocreate_access_role": "ro",
    "saml_autocreate_users_domains": {
      "domains": [
        "example.com"
      ]
    },
    "saml_idp_endpoint": "https://my.saml.endpoint",
    "saml_login_url": "https://my.saml.login.url"
  },
  "subscription": {
    "type": "pro"
  }
}

Response

Example response

{
  "org": {
    "billing": {
      "type": "parent_billing"
    },
    "created": "2019-09-26T17:28:28Z",
    "description": "some description",
    "name": "New child org",
    "public_id": "abcdef12345",
    "settings": {
      "saml_autocreate_access_role": "ro",
      "saml_autocreate_users_domains": {
        "domains": [
          "example.com"
        ]
      },
      "saml_idp_endpoint": "https://my.saml.endpoint",
      "saml_login_url": "https://my.saml.login.url"
    },
    "subscription": {
      "type": "pro"
    }
  }
}