project_roles

Creates, updates, deletes, gets or lists a project_roles resource.

Overview

Name	project_roles
Type	Resource
Id	openai_admin.roles.project_roles

Fields

The following fields are returned by SELECT queries:

list

Project roles listed successfully.

Name	Datatype	Description
id	string	Identifier for the role.
name	string	Unique name for the role.
description	string	Optional description of the role.
object	string	Always role. (role)
permissions	array	Permissions granted by the role.
predefined_role	boolean	Whether the role is predefined and managed by OpenAI.
resource_type	string	Resource type the role is bound to (for example api.organization or api.project).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	project_id	limit, after, order
create	insert	project_id, role_name, permissions
update	update	project_id, role_id
delete	delete	project_id, role_id

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
project_id	string	The ID of the project to update.
role_id	string	The ID of the role to delete.
after	string	Cursor for pagination. Provide the value from the previous response's next field to continue listing roles.
limit	integer	A limit on the number of roles to return. Defaults to 1000.
order	string	Sort order for the returned roles.

SELECT examples

list

Project roles listed successfully.

SELECT
id,
name,
description,
object,
permissions,
predefined_role,
resource_type
FROM openai_admin.roles.project_roles
WHERE project_id = '{{ project_id }}' -- required
AND limit = '{{ limit }}'
AND after = '{{ after }}'
AND order = '{{ order }}'
;

INSERT examples

create

No description available.

INSERT INTO openai_admin.roles.project_roles (
role_name,
permissions,
description,
project_id
)
SELECT 
'{{ role_name }}' /* required */,
'{{ permissions }}' /* required */,
'{{ description }}',
'{{ project_id }}'
RETURNING
id,
name,
description,
object,
permissions,
predefined_role,
resource_type
;

Manifest

# Description fields are for documentation purposes
- name: project_roles
props:
  - name: project_id
    value: "{{ project_id }}"
    description: Required parameter for the project_roles resource.
  - name: role_name
    value: "{{ role_name }}"
    description: |
      Unique name for the role.
  - name: permissions
    value:
      - "{{ permissions }}"
    description: |
      Permissions to grant to the role.
  - name: description
    value: "{{ description }}"
    description: |
      Optional description of the role.

UPDATE examples

update

No description available.

UPDATE openai_admin.roles.project_roles
SET 
permissions = '{{ permissions }}',
description = '{{ description }}',
role_name = '{{ role_name }}'
WHERE 
project_id = '{{ project_id }}' --required
AND role_id = '{{ role_id }}' --required
RETURNING
id,
name,
description,
object,
permissions,
predefined_role,
resource_type;

DELETE examples

delete

No description available.

DELETE FROM openai_admin.roles.project_roles
WHERE project_id = '{{ project_id }}' --required
AND role_id = '{{ role_id }}' --required
;