svc-org-management_other

List unified view of users and invitations in an organization

get/organizations/{organization_id}/identities

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.

query[email]string

Search identities by email substring (case-insensitive)

role'org_admin' | 'org_member' | 'org_viewer'

User's role in the organization

Filter identities by role

afterstring

Pagination cursor for navigating through results

Cursor for forward pagination

beforestring

Pagination cursor for navigating through results

Cursor for backward pagination

limitinteger

Maximum number of identities to return

Headers

X-Client-Request-IDstring uuid

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

Response

List of organization identities (users and invitations)

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

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

Changes

Changed in 4 of the 23 revisions of this API.119

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

      request-parameter-property-enum-value-added

    • added the required property to the response with the status

      response-required-property-added

    • added the new optional query request parameter query[email]

      new-optional-request-parameter

    • 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

  • edd1b760a989113See the full diff
    • added to the // response property oneOf list for the response status

      response-property-one-of-added

    • 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

    • removed from the // response property oneOf list for the response status

      response-property-one-of-removed

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