Retrieve

organizations.retrieve(, ) -> Organization

GET/organizations/{organization_id}

Get organization by ID or label

ParametersExpand Collapse

organization_id: str

Organization ID or label identifier

minLength1

maxLength255

expand: Optional[List[Literal["permissions", "total_count"]]]

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.

Accepts one of the following:

"permissions"

"total_count"

x_client_request_id: Optional[str]

formatuuid

ReturnsExpand Collapse

class Organization: …

id: str

Identifier for API resources. A 26-char nanoid (URL/DNS safe).

minLength1

maxLength255

created_at: datetime

The time the entity was created in utc

formatdate-time

label: str

A domain name segment for the entity, often derived from the name.

maxLength63

name: str

A name for the entity to be displayed in UI

sso_enabled: bool

Whether SSO is enabled for this organization

updated_at: datetime

The time the entity was mostly recently updated in utc

formatdate-time

permissions: Optional[Dict[str, Dict[str, bool]]]

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.

Retrieve

from keycardai_api import KeycardAPI

client = KeycardAPI()
organization = client.organizations.retrieve(
    organization_id="x",
)
print(organization.id)

{
  "id": "ab3def8hij2klm9opq5rst7uvw",
  "created_at": "2019-12-27T18:11:19.117Z",
  "label": "26f1klzn5713-56bincal4ca-60zz1k91s4-j2c13v6",
  "name": "name",
  "sso_enabled": true,
  "updated_at": "2019-12-27T18:11:19.117Z",
  "permissions": {
    "organizations": {
      "read": true,
      "update": true
    },
    "users": {
      "read": true,
      "list": true
    }
  }
}

Returns Examples

{
  "id": "ab3def8hij2klm9opq5rst7uvw",
  "created_at": "2019-12-27T18:11:19.117Z",
  "label": "26f1klzn5713-56bincal4ca-60zz1k91s4-j2c13v6",
  "name": "name",
  "sso_enabled": true,
  "updated_at": "2019-12-27T18:11:19.117Z",
  "permissions": {
    "organizations": {
      "read": true,
      "update": true
    },
    "users": {
      "read": true,
      "list": true
    }
  }
}