List Roles

organizations.roles.list() -> RoleListResponse

GET/api/v1/organizations/{organization_id}/roles

List all roles in an organization.

ParametersExpand Collapse

organization_id: str

ReturnsExpand Collapse

List[Role]

id: str

Unique identifier

formatuuid

name: str

A name for the role.

maxLength3000

minLength1

permissions: List[Permission]

The actual permissions of the role.

id: str

Unique identifier

formatuuid

access: bool

Whether the permission is granted or not.

description: Optional[str]

A description for the permission.

name: str

A name for the permission.

maxLength3000

minLength1

created_at: Optional[datetime]

Creation datetime

formatdate-time

updated_at: Optional[datetime]

Update datetime

formatdate-time

created_at: Optional[datetime]

Creation datetime

formatdate-time

updated_at: Optional[datetime]

Update datetime

formatdate-time

List Roles

import os
from llama_cloud_admin import LlamaCloudAdmin

client = LlamaCloudAdmin(
    api_key=os.environ.get("LLAMA_CLOUD_API_KEY"),  # This is the default and can be omitted
)
roles = client.organizations.roles.list(
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(roles)

[
  {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "name": "x",
    "permissions": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "access": true,
        "description": "description",
        "name": "x",
        "created_at": "2019-12-27T18:11:19.117Z",
        "updated_at": "2019-12-27T18:11:19.117Z"
      }
    ],
    "created_at": "2019-12-27T18:11:19.117Z",
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
]

Returns Examples

[
  {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "name": "x",
    "permissions": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "access": true,
        "description": "description",
        "name": "x",
        "created_at": "2019-12-27T18:11:19.117Z",
        "updated_at": "2019-12-27T18:11:19.117Z"
      }
    ],
    "created_at": "2019-12-27T18:11:19.117Z",
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
]