API Reference

Admin

Organization

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Users

List users

admin.organization.users.list(**kwargs) -> ConversationCursorPage<OrganizationUser { id, added_at, object, 13 more } >

GET/organization/users

Retrieve user

admin.organization.users.retrieve(user_id) -> OrganizationUser { id, added_at, object, 13 more }

GET/organization/users/{user_id}

Modify user

admin.organization.users.update(user_id, **kwargs) -> OrganizationUser { id, added_at, object, 13 more }

POST/organization/users/{user_id}

Delete user

admin.organization.users.delete(user_id) -> UserDeleteResponse { id, deleted, object }

DELETE/organization/users/{user_id}

ModelsExpand Collapse

class OrganizationUser { id, added_at, object, 13 more }

Represents an individual user within an organization.

id: String

The identifier, which can be referenced in API endpoints

added_at: Integer

The Unix timestamp (in seconds) of when the user was added.

formatunixtime

object: :"organization.user"

The object type, which is always organization.user

api_key_last_used_at: Integer

The Unix timestamp (in seconds) of the user’s last API key usage.

formatunixtime

created: Integer

The Unix timestamp (in seconds) of when the user was created.

formatunixtime

developer_persona: String

The developer persona metadata for the user.

email: String

The email address of the user

is_default: bool

Whether this is the organization’s default user.

is_scale_tier_authorized_purchaser: bool

Whether the user is an authorized purchaser for Scale Tier.

is_scim_managed: bool

Whether the user is managed through SCIM.

is_service_account: bool

Whether the user is a service account.

name: String

The name of the user

projects: Projects{ data, object}

Projects associated with the user, if included.

data: Array[Data{ id, name, role}]

id: String

name: String

role: String

object: :list

role: String

owner or reader

technical_level: String

The technical level metadata for the user.

user: User{ id, object, banned, 5 more}

Nested user details.

id: String

object: :user

banned: bool

banned_at: Integer

formatunixtime

email: String

enabled: bool

name: String

picture: String

class UserDeleteResponse { id, deleted, object }

id: String

deleted: bool

object: :"organization.user.deleted"

UsersRoles

List user organization role assignments

admin.organization.users.roles.list(user_id, **kwargs) -> NextCursorPage<RoleListResponse { id, created_at, created_by, 8 more } >

GET/organization/users/{user_id}/roles

Assign organization role to user

admin.organization.users.roles.create(user_id, **kwargs) -> RoleCreateResponse { object, role, user }

POST/organization/users/{user_id}/roles

Unassign organization role from user

admin.organization.users.roles.delete(role_id, **kwargs) -> RoleDeleteResponse { deleted, object }

DELETE/organization/users/{user_id}/roles/{role_id}

ModelsExpand Collapse

class RoleListResponse { id, created_at, created_by, 8 more }

Detailed information about a role assignment entry returned when listing assignments.

id: String

Identifier for the role.

created_at: Integer

When the role was created.

formatunixtime

created_by: String

Identifier of the actor who created the role.

created_by_user_obj: Hash[Symbol, untyped]

User details for the actor that created the role, when available.

description: String

Description of the role.

metadata: Hash[Symbol, untyped]

Arbitrary metadata stored on the role.

name: String

Name of the role.

permissions: Array[String]

Permissions associated with the role.

predefined_role: bool

Whether the role is predefined by OpenAI.

resource_type: String

Resource type the role applies to.

updated_at: Integer

When the role was last updated.

formatint64

class RoleCreateResponse { object, role, user }

Role assignment linking a user to a role.

object: :"user.role"

Always user.role.

role: Role { id, description, name, 4 more }

Details about a role that can be assigned through the public Roles API.

user: OrganizationUser { id, added_at, object, 13 more }

Represents an individual user within an organization.

class RoleDeleteResponse { deleted, object }

Confirmation payload returned after unassigning a role.

deleted: bool

Whether the assignment was removed.

object: String

Identifier for the deleted assignment, such as group.role.deleted or user.role.deleted.