OpenAPI::Client::OpenAI::Path::organization-projects-project_id-service_accounts(3)

NAME
OpenAPI::Client::OpenAI::Path::organization-projects-project_id-service_accounts - Documentation for the /organization/projects/{project_id}/service_accounts path.

DESCRIPTION
This document describes the API endpoint at "/organization/projects/{project_id}/service_accounts".

PATHS

  "GET /organization/projects/{project_id}/service_accounts"
Returns a list of service accounts in the project.

Operation ID

"list-project-service-accounts"

    $client->list-project-service-accounts( ... );

Parameters

•   "project_id" (in path) (Required) - The ID of the project.

    Type: "string"

•   "limit" (in query) (Optional) - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

    Type: "integer"

    Default: 20

•   "after" (in query) (Optional) - A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

    Type: "string"

Responses

Status Code: 200

Project service accounts listed successfully.

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
           "data" : [
              "{\n    \"object\": \"organization.project.service_account\",\n    \"id\": \"svc_acct_abc\",\n    \"name\": \"Service Account\",\n    \"role\": \"owner\",\n    \"created_at\": 1711471533\n}\n"
           ]
        }

Status Code: 400

Error response when project is archived.

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
           "error" : null
        }

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

Operation ID

"create-project-service-account"

    $client->create-project-service-account( ... );

Parameters

•   "project_id" (in path) (Required) - The ID of the project.

    Type: "string"

Request Body

Content Type: "application/json"

Responses

Status Code: 200

Project service account created successfully.

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
           "api_key" : null
        }

Status Code: 400

Error response when project is archived.

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
           "error" : null
        }

SEE ALSO
OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE
Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.