DescribeOrganization

Describes an organization.

get/api/admin/v1/organizations/{org}

Path Parameters

• org ^required

  An organization ID.

  • Schema ResourceId
  • Type string
  • Minimum Length 1
  • Maximum Length 20
  • Pattern ^[A-Z0-9]+$

Query Parameters

This operation does not have query parameters.

Request Body

This operation does not have a request body.

Responses

200 Response

The information about the organization is returned.

• Schema Organization
• Type object
• Properties

  • id ^required

    The organization ID.

    • Schema ResourceId

  • name ^required

    The organization name.

    • Schema OrganizationName

  • createdAt ^required

    The time when the organization was created.

    • Type string
    • Format date-time

  • updatedAt ^required

    The time when the organization was last updated.

    • Type string
    • Format date-time

400 Response

The requested operation cannot be performed because the request is malformed.

• Schema Error
• Type object
• Properties

  • message ^required

    An error message.

    • Type string

401 Response

The requested operation cannot be performed because the request lacks valid authentication credentials.

• Schema Error
• Type object
• Properties

  • message ^required

    An error message.

    • Type string

403 Response

The identity is not allowed to perform the requested operation for the resource involved.

• Schema Error
• Type object
• Properties

  • message ^required

    An error message.

    • Type string

404 Response

The resource or dependent resources involved in the requested operation do not exist.

• Schema Error
• Type object
• Properties

  • message ^required

    An error message.

    • Type string

Default Response

The requested operation failed with an error.

• Schema Error
• Type object
• Properties

  • message ^required

    An error message.

    • Type string