Skip to main content

Retrieve the list of person's organizations​

Retrieve details of all the organizations a person belongs to, including:

  • The organization of the request: the person must be a member of the organization you authenticate with for you to be allowed to retrieve this list
  • Any sub- and super-organizations that share the person pool with the organization of the request: A hierarchy of organizations can be created using this API endpoint. When organizations are configured to share a person pool, if the same person registers with multiple organizations in the pool using the same handle, all organizations will see the same person ID for that person.
Path Parameters
  • person_id string required

    The person ID

    Example: 903c1ff9-f2cc-435c-b242-9d8a690fcf0a
Query Parameters
  • filter string

    A filter to be applied to the result list, using the SCIM 2.0 Filter syntax.

    Example (permission_write): permission eq "write"
Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Responses

OK

Schema
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • cursor_pagination object

    Cursors are opaque. Follow the tokens the server returns; never construct, parse or modify one.

  • limit integer
  • next_cursor string

    Opaque token addressing the next page. Absent on the last page.

  • prev_cursor string

    Opaque token addressing the previous page. Absent on the first page.

  • last_cursor string

    Opaque token addressing the final page directly, so a client can jump to the end without a total count.

  • total_count int64

    Total number of matching items. Returned on the FIRST page only; clients cache it for the remainder of the walk.

  • errors object[]
  • httpcode integer
  • message string
  • result object[]
  • id string
  • parent_id string
  • org_name string
  • tenant_name string
  • managed_organizations object[]
  • id string
  • parent_id string
  • org_name string
  • tenant_name string