Skip to content
LlamaCloud Admin API
Product Docs
API Reference
Organizations
Users

Assign Role To User In Organization

organizations.users.assign_role(strpath_organization_id, UserAssignRoleParams**kwargs) -> UserOrganizationRole
PUT/api/v1/organizations/{organization_id}/users/roles

Assign a role to a user in an organization.

ParametersExpand Collapse
organization_id: str
organization_id: str
role_id: str

The role’s ID.

formatuuid
user_id: str

The user’s ID.

ReturnsExpand Collapse
class UserOrganizationRole: …

Schema for a user’s role in an organization.

id: str

Unique identifier

formatuuid
organization_id: str

The organization’s ID.

formatuuid
role: Role

The 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
user_id: str

The user’s ID.

created_at: Optional[datetime]

Creation datetime

formatdate-time
project_ids: Optional[List[str]]

The project ID scope.

updated_at: Optional[datetime]

Update datetime

formatdate-time

Assign Role To User In Organization

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
)
user_organization_role = client.organizations.users.assign_role(
    path_organization_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    body_organization_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    role_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    user_id="user_id",
)
print(user_organization_role.id)
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "role": {
    "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"
  },
  "user_id": "user_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "project_ids": [
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  ],
  "updated_at": "2019-12-27T18:11:19.117Z"
}
Returns Examples
{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "role": {
    "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"
  },
  "user_id": "user_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "project_ids": [
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  ],
  "updated_at": "2019-12-27T18:11:19.117Z"
}