Admin

AdminOrganizationAudit Logs

List user actions and configuration changes within this organization.

data openai_admin_organization_audit_logs

optional Expand Collapse

before?: String

A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

actor_emails?: List[String]

Return only events performed by users with these emails.

actor_ids?: List[String]

Return only events performed by these actors. Can be a user ID, a service account ID, or an api key tracking ID.

event_types?: List[String]

Return only events with a type in one of these values. For example, project.created. For all options, see the documentation for the audit log object.

project_ids?: List[String]

Return only events for these projects.

resource_ids?: List[String]

Return only events performed on these targets. For example, a project ID updated.

effective_at?: Attributes

Return only events whose effective_at (Unix seconds) is in this range.

gt?: Int64

Return only events whose effective_at (Unix seconds) is greater than this value.

gte?: Int64

Return only events whose effective_at (Unix seconds) is greater than or equal to this value.

lt?: Int64

Return only events whose effective_at (Unix seconds) is less than this value.

lte?: Int64

Return only events whose effective_at (Unix seconds) is less than or equal to this value.

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse

items: List[Attributes]

The items returned by the data source

id: String

The ID of this log.

actor: Attributes

The actor who performed the audit logged action.

api_key: Attributes

The API Key used to perform the audit logged action.

id: String

The tracking id of the API key.

service_account: Attributes

The service account that performed the audit logged action.

id: String

The service account id.

type: String

The type of API key. Can be either user or service_account.

user: Attributes

The user who performed the audit logged action.

id: String

The user id.

email: String

The user email.

session: Attributes

The session in which the audit logged action was performed.

ip_address: String

The IP address from which the action was performed.

user: Attributes

The user who performed the audit logged action.

id: String

The user id.

email: String

The user email.

type: String

The type of actor. Is either session or api_key.

effective_at: Int64

The Unix timestamp (in seconds) of the event.

type: String

The event type.

api_key_created: Attributes

The details for events with this type.

id: String

The tracking ID of the API key.

data: Attributes

The payload used to create the API key.

scopes: List[String]

A list of scopes allowed for the API key, e.g. ["api.model.request"]

api_key_deleted: Attributes

The details for events with this type.

id: String

The tracking ID of the API key.

api_key_updated: Attributes

The details for events with this type.

id: String

The tracking ID of the API key.

changes_requested: Attributes

The payload used to update the API key.

scopes: List[String]

A list of scopes allowed for the API key, e.g. ["api.model.request"]

certificate_created: Attributes

The details for events with this type.

id: String

The certificate ID.

The name of the certificate.

certificate_deleted: Attributes

The details for events with this type.

id: String

The certificate ID.

certificate: String

The certificate content in PEM format.

The name of the certificate.

certificate_updated: Attributes

The details for events with this type.

id: String

The certificate ID.

The name of the certificate.

certificates_activated: Attributes

The details for events with this type.

certificates: List[Attributes]

id: String

The certificate ID.

The name of the certificate.

certificates_deactivated: Attributes

The details for events with this type.

certificates: List[Attributes]

id: String

The certificate ID.

The name of the certificate.

checkpoint_permission_created: Attributes

The project and fine-tuned model checkpoint that the checkpoint permission was created for.

id: String

The ID of the checkpoint permission.

data: Attributes

The payload used to create the checkpoint permission.

fine_tuned_model_checkpoint: String

The ID of the fine-tuned model checkpoint.

project_id: String

The ID of the project that the checkpoint permission was created for.

checkpoint_permission_deleted: Attributes

The details for events with this type.

id: String

The ID of the checkpoint permission.

external_key_registered: Attributes

The details for events with this type.

id: String

The ID of the external key configuration.

data: JSON

The configuration for the external key.

external_key_removed: Attributes

The details for events with this type.

id: String

The ID of the external key configuration.

group_created: Attributes

The details for events with this type.

id: String

The ID of the group.

data: Attributes

Information about the created group.

group_name: String

The group name.

group_deleted: Attributes

The details for events with this type.

id: String

The ID of the group.

group_updated: Attributes

The details for events with this type.

id: String

The ID of the group.

changes_requested: Attributes

The payload used to update the group.

group_name: String

The updated group name.

invite_accepted: Attributes

The details for events with this type.

id: String

The ID of the invite.

invite_deleted: Attributes

The details for events with this type.

id: String

The ID of the invite.

invite_sent: Attributes

The details for events with this type.

id: String

The ID of the invite.

data: Attributes

The payload used to create the invite.

email: String

The email invited to the organization.

role: String

The role the email was invited to be. Is either owner or member.

ip_allowlist_config_activated: Attributes

The details for events with this type.

configs: List[Attributes]

The configurations that were activated.

id: String

The ID of the IP allowlist configuration.

The name of the IP allowlist configuration.

ip_allowlist_config_deactivated: Attributes

The details for events with this type.

configs: List[Attributes]

The configurations that were deactivated.

id: String

The ID of the IP allowlist configuration.

The name of the IP allowlist configuration.

ip_allowlist_created: Attributes

The details for events with this type.

id: String

The ID of the IP allowlist configuration.

allowed_ips: List[String]

The IP addresses or CIDR ranges included in the configuration.

The name of the IP allowlist configuration.

ip_allowlist_deleted: Attributes

The details for events with this type.

id: String

The ID of the IP allowlist configuration.

allowed_ips: List[String]

The IP addresses or CIDR ranges that were in the configuration.

The name of the IP allowlist configuration.

ip_allowlist_updated: Attributes

The details for events with this type.

id: String

The ID of the IP allowlist configuration.

allowed_ips: List[String]

The updated set of IP addresses or CIDR ranges in the configuration.

login_failed: Attributes

The details for events with this type.

error_code: String

The error code of the failure.

error_message: String

The error message of the failure.

login_succeeded: JSON

This event has no additional fields beyond the standard audit log attributes.

logout_failed: Attributes

The details for events with this type.

error_code: String

The error code of the failure.

error_message: String

The error message of the failure.

logout_succeeded: JSON

This event has no additional fields beyond the standard audit log attributes.

organization_updated: Attributes

The details for events with this type.

id: String

The organization ID.

changes_requested: Attributes

The payload used to update the organization settings.

api_call_logging: String

How your organization logs data from supported API calls. One of disabled, enabled_per_call, enabled_for_all_projects, or enabled_for_selected_projects

api_call_logging_project_ids: String

The list of project ids if api_call_logging is set to enabled_for_selected_projects

description: String

The organization description.

The organization name.

threads_ui_visibility: String

Visibility of the threads page which shows messages created with the Assistants API and Playground. One of ANY_ROLE, OWNERS, or NONE.

title: String

The organization title.

usage_dashboard_visibility: String

Visibility of the usage dashboard which shows activity and costs for your organization. One of ANY_ROLE or OWNERS.

project: Attributes

The project that the action was scoped to. Absent for actions not scoped to projects. Note that any admin actions taken via Admin API keys are associated with the default project.

id: String

The project ID.

The project title.

project_archived: Attributes

The details for events with this type.

id: String

The project ID.

project_created: Attributes

The details for events with this type.

id: String

The project ID.

data: Attributes

The payload used to create the project.

The project name.

title: String

The title of the project as seen on the dashboard.

project_deleted: Attributes

The details for events with this type.

id: String

The project ID.

project_updated: Attributes

The details for events with this type.

id: String

The project ID.

changes_requested: Attributes

The payload used to update the project.

title: String

The title of the project as seen on the dashboard.

rate_limit_deleted: Attributes

The details for events with this type.

id: String

The rate limit ID

rate_limit_updated: Attributes

The details for events with this type.

id: String

The rate limit ID

changes_requested: Attributes

The payload used to update the rate limits.

batch_1_day_max_input_tokens: Int64

The maximum batch input tokens per day. Only relevant for certain models.

max_audio_megabytes_per_1_minute: Int64

The maximum audio megabytes per minute. Only relevant for certain models.

max_images_per_1_minute: Int64

The maximum images per minute. Only relevant for certain models.

max_requests_per_1_day: Int64

The maximum requests per day. Only relevant for certain models.

max_requests_per_1_minute: Int64

The maximum requests per minute.

max_tokens_per_1_minute: Int64

The maximum tokens per minute.

role_assignment_created: Attributes

The details for events with this type.

id: String

The identifier of the role assignment.

principal_id: String

The principal (user or group) that received the role.

principal_type: String

The type of principal (user or group) that received the role.

resource_id: String

The resource the role assignment is scoped to.

resource_type: String

The type of resource the role assignment is scoped to.

role_assignment_deleted: Attributes

The details for events with this type.

id: String

The identifier of the role assignment.

principal_id: String

The principal (user or group) that had the role removed.

principal_type: String

The type of principal (user or group) that had the role removed.

resource_id: String

The resource the role assignment was scoped to.

resource_type: String

The type of resource the role assignment was scoped to.

role_created: Attributes

The details for events with this type.

id: String

The role ID.

permissions: List[String]

The permissions granted by the role.

resource_id: String

The resource the role is scoped to.

resource_type: String

The type of resource the role belongs to.

role_name: String

The name of the role.

role_deleted: Attributes

The details for events with this type.

id: String

The role ID.

role_updated: Attributes

The details for events with this type.

id: String

The role ID.

changes_requested: Attributes

The payload used to update the role.

description: String

The updated role description, when provided.

metadata: JSON

Additional metadata stored on the role.

permissions_added: List[String]

The permissions added to the role.

permissions_removed: List[String]

The permissions removed from the role.

resource_id: String

The resource the role is scoped to.

resource_type: String

The type of resource the role belongs to.

role_name: String

The updated role name, when provided.

scim_disabled: Attributes

The details for events with this type.

id: String

The ID of the SCIM was disabled for.

scim_enabled: Attributes

The details for events with this type.

id: String

The ID of the SCIM was enabled for.

service_account_created: Attributes

The details for events with this type.

id: String

The service account ID.

data: Attributes

The payload used to create the service account.

role: String

The role of the service account. Is either owner or member.

service_account_deleted: Attributes

The details for events with this type.

id: String

The service account ID.

service_account_updated: Attributes

The details for events with this type.

id: String

The service account ID.

changes_requested: Attributes

The payload used to updated the service account.

role: String

The role of the service account. Is either owner or member.

user_added: Attributes

The details for events with this type.

id: String

The user ID.

data: Attributes

The payload used to add the user to the project.

role: String

The role of the user. Is either owner or member.

user_deleted: Attributes

The details for events with this type.

id: String

The user ID.

user_updated: Attributes

The details for events with this type.

id: String

The project ID.

changes_requested: Attributes

The payload used to update the user.

role: String

The role of the user. Is either owner or member.

AdminOrganizationAdmin API Keys

resource openai_admin_organization_admin_api_key

required Expand Collapse

computed Expand Collapse

id: String

The identifier, which can be referenced in API endpoints

created_at: Int64

The Unix timestamp (in seconds) of when the API key was created

last_used_at: Int64

The Unix timestamp (in seconds) of when the API key was last used

object: String

The object type, which is always organization.admin_api_key

redacted_value: String

The redacted value of the API key

value: String

The value of the API key. Only shown on create.

owner: Attributes

id: String

The identifier, which can be referenced in API endpoints

created_at: Int64

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

The name of the user

object: String

The object type, which is always organization.user

role: String

Always owner

type: String

Always user

data openai_admin_organization_admin_api_key

optional Expand Collapse

key_id?: String

The ID of the API key.

find_one_by?: Attributes

order?: String

Order results by creation time, ascending or descending.

computed Expand Collapse

id: String

The ID of the API key.

created_at: Int64

The Unix timestamp (in seconds) of when the API key was created

last_used_at: Int64

The Unix timestamp (in seconds) of when the API key was last used

The name of the API key

object: String

The object type, which is always organization.admin_api_key

redacted_value: String

The redacted value of the API key

value: String

The value of the API key. Only shown on create.

owner: Attributes

id: String

The identifier, which can be referenced in API endpoints

created_at: Int64

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

The name of the user

object: String

The object type, which is always organization.user

role: String

Always owner

type: String

Always user

data openai_admin_organization_admin_api_keys

optional Expand Collapse

order?: String

Order results by creation time, ascending or descending.

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse

items: List[Attributes]

The items returned by the data source

id: String

The identifier, which can be referenced in API endpoints

created_at: Int64

The Unix timestamp (in seconds) of when the API key was created

last_used_at: Int64

The Unix timestamp (in seconds) of when the API key was last used

The name of the API key

object: String

The object type, which is always organization.admin_api_key

owner: Attributes

id: String

The identifier, which can be referenced in API endpoints

created_at: Int64

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

The name of the user

object: String

The object type, which is always organization.user

role: String

Always owner

type: String

Always user

redacted_value: String

The redacted value of the API key

value: String

The value of the API key. Only shown on create.

AdminOrganizationInvites

resource openai_admin_organization_invite

required Expand Collapse

email: String

Send an email to this address

role: String

owner or reader

optional Expand Collapse

projects?: List[Attributes]

An array of projects to which membership is granted at the same time the org invite is accepted. If omitted, the user will be invited to the default project for compatibility with legacy behavior.

id: String

Project’s public ID

role: String

Project membership role

computed Expand Collapse

id: String

The identifier, which can be referenced in API endpoints

accepted_at: Int64

The Unix timestamp (in seconds) of when the invite was accepted.

expires_at: Int64

The Unix timestamp (in seconds) of when the invite expires.

invited_at: Int64

The Unix timestamp (in seconds) of when the invite was sent.

object: String

The object type, which is always organization.invite

status: String

accepted,expired, or pending

data openai_admin_organization_invite

required Expand Collapse

invite_id: String

computed Expand Collapse

id: String

accepted_at: Int64

The Unix timestamp (in seconds) of when the invite was accepted.

email: String

The email address of the individual to whom the invite was sent

expires_at: Int64

The Unix timestamp (in seconds) of when the invite expires.

invited_at: Int64

The Unix timestamp (in seconds) of when the invite was sent.

object: String

The object type, which is always organization.invite

role: String

owner or reader

status: String

accepted,expired, or pending

projects: List[Attributes]

The projects that were granted membership upon acceptance of the invite.

id: String

Project’s public ID

role: String

Project membership role

data openai_admin_organization_invites

optional Expand Collapse

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse

items: List[Attributes]

The items returned by the data source

id: String

The identifier, which can be referenced in API endpoints

email: String

The email address of the individual to whom the invite was sent

expires_at: Int64

The Unix timestamp (in seconds) of when the invite expires.

invited_at: Int64

The Unix timestamp (in seconds) of when the invite was sent.

object: String

The object type, which is always organization.invite

role: String

owner or reader

status: String

accepted,expired, or pending

accepted_at: Int64

The Unix timestamp (in seconds) of when the invite was accepted.

projects: List[Attributes]

The projects that were granted membership upon acceptance of the invite.

id: String

Project’s public ID

role: String

Project membership role

AdminOrganizationUsers

resource openai_admin_organization_user

required Expand Collapse

user_id: String

role: String

owner or reader

computed Expand Collapse

id: String

The identifier, which can be referenced in API endpoints

added_at: Int64

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

email: String

The email address of the user

The name of the user

object: String

The object type, which is always organization.user

data openai_admin_organization_user

optional Expand Collapse

user_id?: String

find_one_by?: Attributes

emails?: List[String]

Filter by the email address of users.

computed Expand Collapse

id: String

added_at: Int64

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

email: String

The email address of the user

The name of the user

object: String

The object type, which is always organization.user

role: String

owner or reader

data openai_admin_organization_users

optional Expand Collapse

emails?: List[String]

Filter by the email address of users.

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse

items: List[Attributes]

The items returned by the data source

id: String

The identifier, which can be referenced in API endpoints

added_at: Int64

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

email: String

The email address of the user

The name of the user

object: String

The object type, which is always organization.user

role: String

owner or reader

AdminOrganizationUsersRoles

resource openai_admin_organization_user_role

required Expand Collapse

user_id: String

role_id: String

Identifier of the role to assign.

computed Expand Collapse

object: String

Always user.role.

role: Attributes

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

id: String

Identifier for the role.

description: String

Optional description of the role.

Unique name for the role.

object: String

Always role.

permissions: List[String]

Permissions granted by the role.

predefined_role: Bool

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).

user: Attributes

Represents an individual user within an organization.

id: String

The identifier, which can be referenced in API endpoints

added_at: Int64

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

email: String

The email address of the user

The name of the user

object: String

The object type, which is always organization.user

role: String

owner or reader

data openai_admin_organization_user_roles

required Expand Collapse

user_id: String

optional Expand Collapse

order?: String

Sort order for the returned organization roles.

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse

items: List[Attributes]

The items returned by the data source

id: String

Identifier for the role.

created_at: Int64

When the role was created.

created_by: String

Identifier of the actor who created the role.

created_by_user_obj: Map[JSON]

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

description: String

Description of the role.

metadata: Map[JSON]

Arbitrary metadata stored on the role.

Name of the role.

permissions: List[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: Int64

When the role was last updated.

AdminOrganizationGroups

resource openai_admin_organization_group

required Expand Collapse

Human readable name for the group.

computed Expand Collapse

id: String

Identifier for the group.

created_at: Int64

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

is_scim_managed: Bool

Whether the group is managed through SCIM and controlled by your identity provider.

data openai_admin_organization_groups

optional Expand Collapse

order?: String

Specifies the sort order of the returned groups.

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse

items: List[Attributes]

The items returned by the data source

id: String

Identifier for the group.

created_at: Int64

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

is_scim_managed: Bool

Whether the group is managed through SCIM and controlled by your identity provider.

Display name of the group.

AdminOrganizationGroupsUsers

resource openai_admin_organization_group_user

required Expand Collapse

group_id: String

user_id: String

Identifier of the user to add to the group.

computed Expand Collapse

object: String

Always group.user.

data openai_admin_organization_group_users

required Expand Collapse

group_id: String

optional Expand Collapse

order?: String

Specifies the sort order of users in the list.

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse

items: List[Attributes]

The items returned by the data source

id: String

The identifier, which can be referenced in API endpoints

added_at: Int64

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

email: String

The email address of the user

The name of the user

object: String

The object type, which is always organization.user

role: String

owner or reader

AdminOrganizationGroupsRoles

resource openai_admin_organization_group_role

required Expand Collapse

group_id: String

role_id: String

Identifier of the role to assign.

computed Expand Collapse

object: String

Always group.role.

group: Attributes

Summary information about a group returned in role assignment responses.

id: String

Identifier for the group.

created_at: Int64

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

Display name of the group.

object: String

Always group.

scim_managed: Bool

Whether the group is managed through SCIM.

role: Attributes

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

id: String

Identifier for the role.

description: String

Optional description of the role.

Unique name for the role.

object: String

Always role.

permissions: List[String]

Permissions granted by the role.

predefined_role: Bool

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).

data openai_admin_organization_group_roles

required Expand Collapse

group_id: String

optional Expand Collapse

order?: String

Sort order for the returned organization roles.

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse

items: List[Attributes]

The items returned by the data source

id: String

Identifier for the role.

created_at: Int64

When the role was created.

created_by: String

Identifier of the actor who created the role.

created_by_user_obj: Map[JSON]

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

description: String

Description of the role.

metadata: Map[JSON]

Arbitrary metadata stored on the role.

Name of the role.

permissions: List[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: Int64

When the role was last updated.

AdminOrganizationRoles

resource openai_admin_organization_role

required Expand Collapse

role_name: String

Unique name for the role.

permissions: List[String]

Permissions to grant to the role.

optional Expand Collapse

description?: String

Optional description of the role.

computed Expand Collapse

id: String

Identifier for the role.

Unique name for the role.

object: String

Always role.

predefined_role: Bool

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).

data openai_admin_organization_roles

optional Expand Collapse

order?: String

Sort order for the returned roles.

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse

items: List[Attributes]

The items returned by the data source

id: String

Identifier for the role.

description: String

Optional description of the role.

Unique name for the role.

object: String

Always role.

permissions: List[String]

Permissions granted by the role.

predefined_role: Bool

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).

AdminOrganizationCertificates

resource openai_admin_organization_certificate

required Expand Collapse

content: String

The certificate content in PEM format

optional Expand Collapse

name?: String

An optional name for the certificate

computed Expand Collapse

id: String

The identifier, which can be referenced in API endpoints

active: Bool

Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate.

created_at: Int64

The Unix timestamp (in seconds) of when the certificate was uploaded.

object: String

The object type.

If creating, updating, or getting a specific certificate, the object type is certificate.
If listing, activating, or deactivating certificates for the organization, the object type is organization.certificate.
If listing, activating, or deactivating certificates for a project, the object type is organization.project.certificate.

certificate_details: Attributes

content: String

The content of the certificate in PEM format.

expires_at: Int64

The Unix timestamp (in seconds) of when the certificate expires.

valid_at: Int64

The Unix timestamp (in seconds) of when the certificate becomes valid.

data openai_admin_organization_certificate

optional Expand Collapse

certificate_id?: String

include?: List[String]

A list of additional fields to include in the response. Currently the only supported value is content to fetch the PEM content of the certificate.

find_one_by?: Attributes

order?: String

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

computed Expand Collapse

id: String

active: Bool

Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate.

created_at: Int64

The Unix timestamp (in seconds) of when the certificate was uploaded.

The name of the certificate.

object: String

The object type.

If creating, updating, or getting a specific certificate, the object type is certificate.
If listing, activating, or deactivating certificates for the organization, the object type is organization.certificate.
If listing, activating, or deactivating certificates for a project, the object type is organization.project.certificate.

certificate_details: Attributes

content: String

The content of the certificate in PEM format.

expires_at: Int64

The Unix timestamp (in seconds) of when the certificate expires.

valid_at: Int64

The Unix timestamp (in seconds) of when the certificate becomes valid.

data openai_admin_organization_certificates

optional Expand Collapse

order?: String

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse

items: List[Attributes]

The items returned by the data source

id: String

The identifier, which can be referenced in API endpoints

certificate_details: Attributes

content: String

The content of the certificate in PEM format.

expires_at: Int64

The Unix timestamp (in seconds) of when the certificate expires.

valid_at: Int64

The Unix timestamp (in seconds) of when the certificate becomes valid.

created_at: Int64

The Unix timestamp (in seconds) of when the certificate was uploaded.

The name of the certificate.

object: String

The object type.

If creating, updating, or getting a specific certificate, the object type is certificate.
If listing, activating, or deactivating certificates for the organization, the object type is organization.certificate.
If listing, activating, or deactivating certificates for a project, the object type is organization.project.certificate.

active: Bool

Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate.

AdminOrganizationProjects

resource openai_admin_organization_project

required Expand Collapse

The friendly name of the project, this name appears in reports.

optional Expand Collapse

geography?: String

Create the project with the specified data residency region. Your organization must have access to Data residency functionality in order to use. See data residency controls to review the functionality and limitations of setting this field.

computed Expand Collapse

id: String

The identifier, which can be referenced in API endpoints

archived_at: Int64

The Unix timestamp (in seconds) of when the project was archived or null.

created_at: Int64

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

object: String

The object type, which is always organization.project

status: String

active or archived

data openai_admin_organization_project

optional Expand Collapse

project_id?: String

find_one_by?: Attributes

include_archived?: Bool

If true returns all projects including those that have been archived. Archived projects are not included by default.

computed Expand Collapse

id: String

archived_at: Int64

The Unix timestamp (in seconds) of when the project was archived or null.

created_at: Int64

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

The name of the project. This appears in reporting.

object: String

The object type, which is always organization.project

status: String

active or archived

data openai_admin_organization_projects

optional Expand Collapse

include_archived?: Bool

If true returns all projects including those that have been archived. Archived projects are not included by default.

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse

items: List[Attributes]

The items returned by the data source

id: String

The identifier, which can be referenced in API endpoints

created_at: Int64

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

The name of the project. This appears in reporting.

object: String

The object type, which is always organization.project

status: String

active or archived

archived_at: Int64

The Unix timestamp (in seconds) of when the project was archived or null.

AdminOrganizationProjectsUsers

resource openai_admin_organization_project_user

required Expand Collapse

project_id: String

user_id: String

The ID of the user.

role: String

owner or member

computed Expand Collapse

id: String

The identifier, which can be referenced in API endpoints

added_at: Int64

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

email: String

The email address of the user

The name of the user

object: String

The object type, which is always organization.project.user

data openai_admin_organization_project_user

required Expand Collapse

user_id: String

project_id: String

computed Expand Collapse

id: String

added_at: Int64

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

email: String

The email address of the user

The name of the user

object: String

The object type, which is always organization.project.user

role: String

owner or member

data openai_admin_organization_project_users

required Expand Collapse

project_id: String

optional Expand Collapse

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse

items: List[Attributes]

The items returned by the data source

id: String

The identifier, which can be referenced in API endpoints

added_at: Int64

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

email: String

The email address of the user

The name of the user

object: String

The object type, which is always organization.project.user

role: String

owner or member

AdminOrganizationProjectsUsersRoles

resource openai_admin_organization_project_user_role

required Expand Collapse

project_id: String

user_id: String

role_id: String

Identifier of the role to assign.

computed Expand Collapse

object: String

Always user.role.

role: Attributes

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

id: String

Identifier for the role.

description: String

Optional description of the role.

Unique name for the role.

object: String

Always role.

permissions: List[String]

Permissions granted by the role.

predefined_role: Bool

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).

user: Attributes

Represents an individual user within an organization.

id: String

The identifier, which can be referenced in API endpoints

added_at: Int64

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

email: String

The email address of the user

The name of the user

object: String

The object type, which is always organization.user

role: String

owner or reader

data openai_admin_organization_project_user_roles

required Expand Collapse

project_id: String

user_id: String

optional Expand Collapse

order?: String

Sort order for the returned project roles.

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse

items: List[Attributes]

The items returned by the data source

id: String

Identifier for the role.

created_at: Int64

When the role was created.

created_by: String

Identifier of the actor who created the role.

created_by_user_obj: Map[JSON]

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

description: String

Description of the role.

metadata: Map[JSON]

Arbitrary metadata stored on the role.

Name of the role.

permissions: List[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: Int64

When the role was last updated.

AdminOrganizationProjectsService Accounts

resource openai_admin_organization_project_service_account

required Expand Collapse

project_id: String

The name of the service account being created.

computed Expand Collapse

id: String

created_at: Int64

The Unix timestamp (in seconds) of when the service account was created

object: String

The object type, which is always organization.project.service_account

role: String

owner or member

api_key: Attributes

id: String

created_at: Int64

object: String

The object type, which is always organization.project.service_account.api_key

value: String

data openai_admin_organization_project_service_account

required Expand Collapse

service_account_id: String

project_id: String

computed Expand Collapse

id: String

created_at: Int64

The Unix timestamp (in seconds) of when the service account was created

The name of the service account

object: String

The object type, which is always organization.project.service_account

role: String

owner or member

data openai_admin_organization_project_service_accounts

required Expand Collapse

project_id: String

optional Expand Collapse

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse

items: List[Attributes]

The items returned by the data source

id: String

The identifier, which can be referenced in API endpoints

created_at: Int64

The Unix timestamp (in seconds) of when the service account was created

The name of the service account

object: String

The object type, which is always organization.project.service_account

role: String

owner or member

AdminOrganizationProjectsAPI Keys

data openai_admin_organization_project_api_key

required Expand Collapse

key_id: String

project_id: String

computed Expand Collapse

created_at: Int64

The Unix timestamp (in seconds) of when the API key was created

id: String

The identifier, which can be referenced in API endpoints

last_used_at: Int64

The Unix timestamp (in seconds) of when the API key was last used.

The name of the API key

object: String

The object type, which is always organization.project.api_key

redacted_value: String

The redacted value of the API key

owner: Attributes

service_account: Attributes

Represents an individual service account in a project.

id: String

The identifier, which can be referenced in API endpoints

created_at: Int64

The Unix timestamp (in seconds) of when the service account was created

The name of the service account

object: String

The object type, which is always organization.project.service_account

role: String

owner or member

type: String

user or service_account

user: Attributes

Represents an individual user in a project.

id: String

The identifier, which can be referenced in API endpoints

added_at: Int64

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

email: String

The email address of the user

The name of the user

object: String

The object type, which is always organization.project.user

role: String

owner or member

data openai_admin_organization_project_api_keys

required Expand Collapse

project_id: String

optional Expand Collapse

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse

items: List[Attributes]

The items returned by the data source

id: String

The identifier, which can be referenced in API endpoints

created_at: Int64

The Unix timestamp (in seconds) of when the API key was created

last_used_at: Int64

The Unix timestamp (in seconds) of when the API key was last used.

The name of the API key

object: String

The object type, which is always organization.project.api_key

owner: Attributes

service_account: Attributes

Represents an individual service account in a project.

id: String

The identifier, which can be referenced in API endpoints

created_at: Int64

The Unix timestamp (in seconds) of when the service account was created

The name of the service account

object: String

The object type, which is always organization.project.service_account

role: String

owner or member

type: String

user or service_account

user: Attributes

Represents an individual user in a project.

id: String

The identifier, which can be referenced in API endpoints

added_at: Int64

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

email: String

The email address of the user

The name of the user

object: String

The object type, which is always organization.project.user

role: String

owner or member

redacted_value: String

The redacted value of the API key

AdminOrganizationProjectsGroups

resource openai_admin_organization_project_group

required Expand Collapse

project_id: String

group_id: String

Identifier of the group to add to the project.

role: String

Identifier of the project role to grant to the group.

computed Expand Collapse

created_at: Int64

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

group_name: String

Display name of the group.

object: String

Always project.group.

data openai_admin_organization_project_groups

required Expand Collapse

project_id: String

optional Expand Collapse

order?: String

Sort order for the returned groups.

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse

items: List[Attributes]

The items returned by the data source

created_at: Int64

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

group_id: String

Identifier of the group that has access to the project.

group_name: String

Display name of the group.

object: String

Always project.group.

project_id: String

Identifier of the project.

AdminOrganizationProjectsGroupsRoles

resource openai_admin_organization_project_group_role

required Expand Collapse

group_id: String

project_id: String

role_id: String

Identifier of the role to assign.

computed Expand Collapse

object: String

Always group.role.

group: Attributes

Summary information about a group returned in role assignment responses.

id: String

Identifier for the group.

created_at: Int64

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

Display name of the group.

object: String

Always group.

scim_managed: Bool

Whether the group is managed through SCIM.

role: Attributes

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

id: String

Identifier for the role.

description: String

Optional description of the role.

Unique name for the role.

object: String

Always role.

permissions: List[String]

Permissions granted by the role.

predefined_role: Bool

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).

data openai_admin_organization_project_group_roles

required Expand Collapse

group_id: String

project_id: String

optional Expand Collapse

order?: String

Sort order for the returned project roles.

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse

items: List[Attributes]

The items returned by the data source

id: String

Identifier for the role.

created_at: Int64

When the role was created.

created_by: String

Identifier of the actor who created the role.

created_by_user_obj: Map[JSON]

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

description: String

Description of the role.

metadata: Map[JSON]

Arbitrary metadata stored on the role.

Name of the role.

permissions: List[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: Int64

When the role was last updated.

AdminOrganizationProjectsRoles

resource openai_admin_organization_project_role

required Expand Collapse

project_id: String

role_name: String

Unique name for the role.

permissions: List[String]

Permissions to grant to the role.

optional Expand Collapse

description?: String

Optional description of the role.

computed Expand Collapse

id: String

Identifier for the role.

Unique name for the role.

object: String

Always role.

predefined_role: Bool

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).

data openai_admin_organization_project_roles

required Expand Collapse

project_id: String

optional Expand Collapse

order?: String

Sort order for the returned roles.

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse

items: List[Attributes]

The items returned by the data source

id: String

Identifier for the role.

description: String

Optional description of the role.

Unique name for the role.

object: String

Always role.

permissions: List[String]

Permissions granted by the role.

predefined_role: Bool

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).

AdminOrganizationProjectsCertificates

data openai_admin_organization_project_certificates

required Expand Collapse

project_id: String

optional Expand Collapse

order?: String

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse

items: List[Attributes]

The items returned by the data source

id: String

The identifier, which can be referenced in API endpoints

certificate_details: Attributes

content: String

The content of the certificate in PEM format.

expires_at: Int64

The Unix timestamp (in seconds) of when the certificate expires.

valid_at: Int64

The Unix timestamp (in seconds) of when the certificate becomes valid.

created_at: Int64

The Unix timestamp (in seconds) of when the certificate was uploaded.

The name of the certificate.

object: String

The object type.

If creating, updating, or getting a specific certificate, the object type is certificate.
If listing, activating, or deactivating certificates for the organization, the object type is organization.certificate.
If listing, activating, or deactivating certificates for a project, the object type is organization.project.certificate.

active: Bool

Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate.

Suggested

Admin

AdminOrganizationAudit Logs

data openai_admin_organization_audit_logs

optional Expand Collapse

computed Expand Collapse

AdminOrganizationAdmin API Keys

resource openai_admin_organization_admin_api_key

required Expand Collapse

computed Expand Collapse

data openai_admin_organization_admin_api_key

optional Expand Collapse

computed Expand Collapse

data openai_admin_organization_admin_api_keys

optional Expand Collapse

computed Expand Collapse

AdminOrganizationInvites

resource openai_admin_organization_invite

required Expand Collapse

optional Expand Collapse

computed Expand Collapse

data openai_admin_organization_invite

required Expand Collapse

computed Expand Collapse

data openai_admin_organization_invites

optional Expand Collapse

computed Expand Collapse

AdminOrganizationUsers

resource openai_admin_organization_user

required Expand Collapse

computed Expand Collapse

data openai_admin_organization_user

optional Expand Collapse

computed Expand Collapse

data openai_admin_organization_users

optional Expand Collapse

computed Expand Collapse

AdminOrganizationUsersRoles

resource openai_admin_organization_user_role

required Expand Collapse

computed Expand Collapse

data openai_admin_organization_user_roles

required Expand Collapse

optional Expand Collapse

computed Expand Collapse

AdminOrganizationGroups

resource openai_admin_organization_group

required Expand Collapse

computed Expand Collapse

data openai_admin_organization_groups

optional Expand Collapse

computed Expand Collapse

AdminOrganizationGroupsUsers

resource openai_admin_organization_group_user

required Expand Collapse

computed Expand Collapse

data openai_admin_organization_group_users

required Expand Collapse

optional Expand Collapse

computed Expand Collapse

AdminOrganizationGroupsRoles

resource openai_admin_organization_group_role

required Expand Collapse

computed Expand Collapse

data openai_admin_organization_group_roles

required Expand Collapse

optional Expand Collapse

computed Expand Collapse

AdminOrganizationRoles

resource openai_admin_organization_role

required Expand Collapse

optional Expand Collapse

computed Expand Collapse

data openai_admin_organization_roles

optional Expand Collapse

computed Expand Collapse

AdminOrganizationCertificates

resource openai_admin_organization_certificate

required Expand Collapse

optional Expand Collapse