Skip to main content

Retrieve information about an organization​

Retrieve information about which other organizations the given shares persons and groups with.

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
  • code string

    Machine-readable reason, present only for errors that define one. Values today: unserved_org_region (the organization is homed in a region this deployment does not serve), wrong_region (the request must be sent to the organization's home region), region_route_missing (this instance has no route to the organization's home region).

  • result object
  • id string
  • parent_id string
  • org_name string
  • tenant_name string
  • nhi_region string

    Possible values: [us-iowa, europe-belgium, asia-japan, europe-england, australia-sydney]

    NHI data region the organization is homed in. Immutable.

  • persons_pool_org_ids string[]

    The list of organizations or suborganizations that share user identities with this organization

  • group_pool_org_ids string[]

    The list of organizations or suborganizations that share user groups with this organization

  • inherits_rbac_pools boolean