Organizations

organizations

Methods

Create Organization ->
post/v1/organizations

Create a new organization

Get Organization Details ->
get/v1/organizations/{organization_id}

Get details about an Organization

Update Organization ->
patch/v1/organizations/{organization_id}

Update an existing organization

List Organizations -> Cursor<>
get/v1/organizations

List organizations

Leave Organization ->
post/v1/organizations/{organization_id}/leave

Leave an Organization

Domain types

Organization = { id, created_at, domains, 5 more... }

Organization response.

OrganizationDomain = { id, domain, verified }

Organization domain details.

OrganizationList = { items, pagination }
OrganizationServices = { cloud, jit_provisioning, scim, 2 more... }

Services that the Organization has access to.

Organizations

Memberships

organizations.memberships

Methods

Get Organization Membership ->
get/v1/organizations/{organization_id}/memberships/{membership_id}

Get details about an organization membership

List Organization Memberships -> Cursor<>
get/v1/organizations/{organization_id}/memberships

List all memberships for an organization

path Parameters
organization_id: string
query Parameters
cursor: string
Optional

Pagination cursor returned by a previous request

limit: number
Optional
(maximum: 100, minimum: 10, default: 10)

Maximum number of items to return

Request example
200Example

Domain types

OrganizationMembership = { id, created_at, organization_id, 3 more... }

Organization membership details.

OrganizationMembershipList = { items, pagination }