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.

Parameters

credential_id: str

Returns

CredentialSecret

result: str

object: Optional[str]

(default: "credential_decrypt")

Request example

from scale_gp_beta import SGPClient

client = SGPClient(
    api_key="My API Key",
)
credential_secret = client.credentials.decrypt(
    "credential_id",
)
print(credential_secret.result)

200Example

{
  "result": "result",
  "object": "object"
}

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.

client.credentials.delete() ->

CredentialDeleteResponse

delete/v5/credentials/{credential_id}

Permanently delete a credential and all its associated data.

Domain types

class Credential: ...

class CredentialSecret: ...