Skip to content

Suggested

Service Accounts

Create project service account

admin.organization.projects.service_accounts.create(, ) -> ServiceAccountCreateResponse

POST/organization/projects/{project_id}/service_accounts

Creates a new service account in the project. This also returns an unredacted API key for the service account.

ParametersExpand Collapse

project_id: str

name: str

The name of the service account being created.

ReturnsExpand Collapse

class ServiceAccountCreateResponse: …

id: str

api_key: Optional[APIKey]

id: str

created_at: int

formatunixtime

name: str

object: Literal["organization.project.service_account.api_key"]

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

value: str

created_at: int

formatunixtime

name: str

object: Literal["organization.project.service_account"]

role: Literal["member"]

Service accounts can only have one role of type member

Create project service account

import os
from openai import OpenAI

client = OpenAI(
    admin_api_key=os.environ.get("OPENAI_ADMIN_KEY"),  # This is the default and can be omitted
)
service_account = client.admin.organization.projects.service_accounts.create(
    project_id="project_id",
    name="name",
)
print(service_account.id)

{
    "object": "organization.project.service_account",
    "id": "svc_acct_abc",
    "name": "Production App",
    "role": "member",
    "created_at": 1711471533,
    "api_key": {
        "object": "organization.project.service_account.api_key",
        "value": "sk-abcdefghijklmnop123",
        "name": "Secret Key",
        "created_at": 1711471533,
        "id": "key_abc"
    }
}

Returns Examples

{
    "object": "organization.project.service_account",
    "id": "svc_acct_abc",
    "name": "Production App",
    "role": "member",
    "created_at": 1711471533,
    "api_key": {
        "object": "organization.project.service_account.api_key",
        "value": "sk-abcdefghijklmnop123",
        "name": "Secret Key",
        "created_at": 1711471533,
        "id": "key_abc"
    }
}