Class: Zavudev::Resources::SubAccounts::APIKeys

Inherits:
Object
  • Object
show all
Defined in:
lib/zavudev/resources/sub_accounts/api_keys.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ APIKeys

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

Parameters:



85
86
87
 
# File 'lib/zavudev/resources/sub_accounts/api_keys.rb', line 85

def initialize(client:)
  @client = client
end

Instance Method Details

#create(id, name:, environment: nil, permissions: nil, request_options: {}) ⇒ Zavudev::Models::SubAccounts::APIKeyCreateResponse

Create sub-account API key

Parameters:

Returns:

See Also:



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/zavudev/resources/sub_accounts/api_keys.rb', line 24

def create(id, params)
  parsed, options = Zavudev::SubAccounts::APIKeyCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/sub-accounts/%1$s/api-keys", id],
    body: parsed,
    model: Zavudev::Models::SubAccounts::APIKeyCreateResponse,
    options: options
  )
end

#list(id, request_options: {}) ⇒ Zavudev::Models::SubAccounts::APIKeyListResponse

List sub-account API keys

Parameters:

Returns:

See Also:



46
47
48
49
50
51
52
53
 
# File 'lib/zavudev/resources/sub_accounts/api_keys.rb', line 46

def list(id, params = {})
  @client.request(
    method: :get,
    path: ["v1/sub-accounts/%1$s/api-keys", id],
    model: Zavudev::Models::SubAccounts::APIKeyListResponse,
    options: params[:request_options]
  )
end

#revoke(key_id, id:, request_options: {}) ⇒ nil

Revoke sub-account API key

Parameters:

  • key_id (String) —

    API key ID.

  • id (String) —

    Sub-account ID.

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

Returns:

  • (nil)

See Also:



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/zavudev/resources/sub_accounts/api_keys.rb', line 68

def revoke(key_id, params)
  parsed, options = Zavudev::SubAccounts::APIKeyRevokeParams.dump_request(params)
  id =
    parsed.delete(:id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["v1/sub-accounts/%1$s/api-keys/%2$s", id, key_id],
    model: NilClass,
    options: options
  )
end