Class: OpenAI::Resources::Admin::Organization::AdminAPIKeys

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/admin/organization/admin_api_keys.rb,
sig/openai/resources/admin/organization/admin_api_keys.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ AdminAPIKeys

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of AdminAPIKeys.

Parameters:



114
115
116
 
# File 'lib/openai/resources/admin/organization/admin_api_keys.rb', line 114

def initialize(client:)
  @client = client
end

Instance Method Details

#create(name:, expires_in_seconds: nil, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::AdminAPIKeyCreateResponse

Create an organization admin API key

Parameters:

  • name (String)
  • expires_in_seconds (Integer) —

    The number of seconds until the API key expires. Omit this field for a key that does not expire.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/openai/resources/admin/organization/admin_api_keys.rb', line 23

def create(params)
  parsed, options = OpenAI::Admin::Organization::AdminAPIKeyCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "organization/admin_api_keys",
    body: parsed,
    model: OpenAI::Models::Admin::Organization::AdminAPIKeyCreateResponse,
    security: {admin_api_key_auth: true},
    options: options
  )
end

#delete(key_id, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::AdminAPIKeyDeleteResponse

Delete an organization admin API key

Parameters:

  • key_id (String) —

    The ID of the API key to be deleted.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



101
102
103
104
105
106
107
108
109
 
# File 'lib/openai/resources/admin/organization/admin_api_keys.rb', line 101

def delete(key_id, params = {})
  @client.request(
    method: :delete,
    path: ["organization/admin_api_keys/%1$s", key_id],
    model: OpenAI::Models::Admin::Organization::AdminAPIKeyDeleteResponse,
    security: {admin_api_key_auth: true},
    options: params[:request_options]
  )
end

#list(after: nil, limit: nil, order: nil, request_options: {}) ⇒ OpenAI::Internal::CursorPage<OpenAI::Models::Admin::Organization::AdminAPIKey>

List organization API keys

Parameters:

Returns:

See Also:



75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/openai/resources/admin/organization/admin_api_keys.rb', line 75

def list(params = {})
  parsed, options = OpenAI::Admin::Organization::AdminAPIKeyListParams.dump_request(params)
  query = OpenAI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "organization/admin_api_keys",
    query: query,
    page: OpenAI::Internal::CursorPage,
    model: OpenAI::Admin::Organization::AdminAPIKey,
    security: {admin_api_key_auth: true},
    options: options
  )
end

#retrieve(key_id, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::AdminAPIKey

Retrieve a single organization API key

Parameters:

  • key_id (String) —

    The ID of the API key.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



47
48
49
50
51
52
53
54
55
 
# File 'lib/openai/resources/admin/organization/admin_api_keys.rb', line 47

def retrieve(key_id, params = {})
  @client.request(
    method: :get,
    path: ["organization/admin_api_keys/%1$s", key_id],
    model: OpenAI::Admin::Organization::AdminAPIKey,
    security: {admin_api_key_auth: true},
    options: params[:request_options]
  )
end