Credentials

Table of Contents

• Credentials

  • Client

Client

class Credentials.Client

A client object representing ‘Credentials’ Service:

import almdrlib

client = almdrlib.client('credentials')

Available methods:

• create_credential()

• delete_credential()

• get_credential()

• list_credentials()

create_credential(**kwargs)

Create new credential

Request Syntax

response = client.create_credential(
    account_id='string'
    name='string'
    secrets='dict'
)

Parameters

• account_id (string) –

  [REQUIRED]

  AIMS Account ID

• name (string) –

  [REQUIRED]

  User-defined credential name

• secrets (dict) –

  [REQUIRED]

  Credential secrets Object

Returns

None

delete_credential(**kwargs)

Request Syntax

response = client.delete_credential(
    account_id='string'
    credential_id='string'
)

Parameters

• account_id (string) – [REQUIRED]

• credential_id (string) – [REQUIRED]

Returns

None

get_credential(**kwargs)

Get Credentail Object for a given customer

Request Syntax

response = client.get_credential(
    account_id='string'
    credential_id='string'
)

Parameters

• account_id (string) – [REQUIRED]

• credential_id (string) – [REQUIRED]

Return type

dict

Returns

Response Syntax

'dict'

Response Definitions

list_credentials(**kwargs)

Request Syntax

response = client.list_credentials(
    account_id='string'
)

Parameters

account_id (string) –

[REQUIRED]

AIMS Account ID

Return type

list

Returns

Response Syntax

[
    'dict'
]

Response Definitions

• (dict) –