Documentation | Credentials

Credentials

CredentialsResource

Methods

client.credentials.create() ->

Credential

post/v5/credentials

Create a new credential for storing sensitive data like API keys, tokens, or other secrets.

client.credentials.retrieve() ->

Credential

get/v5/credentials/{credential_id}

Retrieve a specific credential by its unique identifier.

client.credentials.retrieve_by_name() ->

Credential

get/v5/credentials/name/{credential_name}

Retrieve a specific credential by its name.

client.credentials.decrypt() ->

CredentialSecret

post/v5/credentials/{credential_id}/secret

Retrieve the plaintext payload of a credential by its ID.

client.credentials.decrypt_by_name() ->

CredentialSecret

post/v5/credentials/name/{credential_name}/secret

Retrieve the plaintext payload of a credential by its name.

client.credentials.list() -> SyncCursorPage[

Credential

]

get/v5/credentials

Retrieve a paginated list of all credentials for the current account with optional name filtering.

client.credentials.update(, ) ->

Credential

patch/v5/credentials/{credential_id}

Update an existing credential's properties including name, description, type, payload, and metadata.

Parameters

credential_id: str

credential_metadata: Optional[Dict[str,

object

]]

Optional unencrypted credential_metadata

description: Optional[str]

Optional description

name: Optional[str]

User-friendly name for the credential

payload: Optional[str]

(format: password)

The credential payload to be encrypted

type: Optional[str]

Type of credential: key or json

Returns

Credential

id: str

created_at:

datetime

(format: date-time)

created_by_identity_type: str

created_by_user_id: str

credential_metadata: Dict[str,

object

]

description: str

name: str

type: str

updated_at:

datetime

(format: date-time)

object: Optional[str]

(default: "credential")

Request example

from scale_gp_beta import SGPClient

client = SGPClient(
    api_key="My API Key",
)
credential = client.credentials.update(
    credential_id="credential_id",
)
print(credential.id)

200Example

{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by_identity_type": "created_by_identity_type",
  "created_by_user_id": "created_by_user_id",
  "credential_metadata": {
    "foo": "bar"
  },
  "description": "description",
  "name": "name",
  "type": "type",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "object": "object"
}

client.credentials.delete() ->

CredentialDeleteResponse

delete/v5/credentials/{credential_id}

Permanently delete a credential and all its associated data.

Domain types

class Credential: ...

class CredentialSecret: ...