API Reference

Admin

Organization

Projects

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Groups

Add project group

POST/organization/projects/{project_id}/groups

Remove project group

DELETE/organization/projects/{project_id}/groups/{group_id}

List project groups

GET/organization/projects/{project_id}/groups

Retrieve project group

GET/organization/projects/{project_id}/groups/{group_id}

ModelsExpand Collapse

GroupDeleteResponse object { deleted, object }

Confirmation payload returned after removing a group from a project.

deleted: boolean

Whether the group membership in the project was removed.

object: "project.group.deleted"

Always project.group.deleted.

ProjectGroup object { created_at, group_id, group_name, 3 more }

Details about a group’s membership in a project.

created_at: number

Unix timestamp (in seconds) when the group was granted project access.

formatunixtime

group_id: string

Identifier of the group that has access to the project.

group_name: string

Display name of the group.

group_type: "group" or "tenant_group"

The type of the group.

One of the following:

"group"

"tenant_group"

object: "project.group"

Always project.group.

project_id: string

Identifier of the project.

GroupsRoles

Assign project role to group

POST/projects/{project_id}/groups/{group_id}/roles

Unassign project role from group

DELETE/projects/{project_id}/groups/{group_id}/roles/{role_id}

List project group role assignments

GET/projects/{project_id}/groups/{group_id}/roles

Retrieve project group role

GET/projects/{project_id}/groups/{group_id}/roles/{role_id}

ModelsExpand Collapse

RoleCreateResponse object { group, object, role }

Role assignment linking a group to a role.

group: object { id, created_at, name, 2 more }

Summary information about a group returned in role assignment responses.

id: string

Identifier for the group.

created_at: number

Unix timestamp (in seconds) when the group was created.

formatunixtime

name: string

Display name of the group.

object: "group"

Always group.

scim_managed: boolean

Whether the group is managed through SCIM.

object: "group.role"

Always group.role.

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

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

RoleDeleteResponse object { deleted, object }

Confirmation payload returned after unassigning a role.

deleted: boolean

Whether the assignment was removed.

object: string

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

RoleListResponse object { id, assignment_sources, created_at, 9 more }

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

id: string

Identifier for the role.

assignment_sources: array of object { principal_id, principal_type }

Principals from which the role assignment is inherited, when available.

principal_id: string

principal_type: string

created_at: number

When the role was created.

formatunixtime

created_by: string

Identifier of the actor who created the role.

created_by_user_obj: map[unknown]

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

description: string

Description of the role.

metadata: map[unknown]

Arbitrary metadata stored on the role.

name: string

Name of the role.

permissions: array of string

Permissions associated with the role.

predefined_role: boolean

Whether the role is predefined by OpenAI.

resource_type: string

Resource type the role applies to.

updated_at: number

When the role was last updated.

formatunixtime

RoleRetrieveResponse object { id, assignment_sources, created_at, 9 more }

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

id: string

Identifier for the role.

assignment_sources: array of object { principal_id, principal_type }

Principals from which the role assignment is inherited, when available.

principal_id: string

principal_type: string

created_at: number

When the role was created.

formatunixtime

created_by: string

Identifier of the actor who created the role.

created_by_user_obj: map[unknown]

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

description: string

Description of the role.

metadata: map[unknown]

Arbitrary metadata stored on the role.

name: string

Name of the role.

permissions: array of string

Permissions associated with the role.

predefined_role: boolean

Whether the role is predefined by OpenAI.

resource_type: string

Resource type the role applies to.

updated_at: number

When the role was last updated.

formatunixtime