svc-org-management_other

Get organization by ID or label

get/organizations/{organization_id}

Path parameters

organization_idstring required

Organization ID or label identifier

Organization ID or label

Query parameters

expand[]string[]

Fields to expand in the response. Supports "permissions" to include the permissions field with the caller's permissions for the resource. For list organization identities only, "total_count" populates pagination.total_count with the number of identities matching the same filters as the list (excluding cursor and limit). Other operations ignore expand values they do not use.

Headers

X-Client-Request-IDstring uuid

Unique request identifier specified by the originating caller and passed along by proxies.

Response

Organization details

idstring required

Identifier for API resources. A 26-char nanoid (URL/DNS safe).

namestring required

A name for the entity to be displayed in UI

labelstring required

A domain name segment for the entity, often derived from the name.

sso_enabledboolean required

Whether SSO is enabled for this organization

created_atstring date-time required

The time the entity was created in utc

updated_atstring date-time required

The time the entity was mostly recently updated in utc

permissionsOrgManagementPermissions

Permissions granted to the authenticated principal for this resource. Only populated when the 'expand[]=permissions' query parameter is provided. Keys are resource types (e.g., "organizations"), values are objects mapping permission names to boolean values indicating if the permission is granted.

Example response

{
  "id": "ab3def8hij2klm9opq5rst7uvw",
  "permissions": {
    "organizations": {
      "read": true,
      "update": true
    },
    "users": {
      "read": true,
      "list": true
    }
  }
}

Changes

Changed in 3 of the 23 revisions of this API.16

    • added the enum value total_count to the property items/ of the query request parameter expand[]

      request-parameter-property-enum-value-added

    • the endpoint scheme security OAuth2 was added to the API

      api-security-added

    • the endpoint scheme security bearerAuth was added to the API

      api-security-added

    • the endpoint scheme security org-management_bearerAuth was removed from the API

      api-security-removed

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • deleted the header request parameter X-Request-ID

      request-parameter-removed

    • the endpoint scheme security org-management_bearerAuth was added to the API

      api-security-added

    • the endpoint scheme security svc-org-management_bearerAuth was removed from the API

      api-security-removed

    This revision also has 82 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog