Documentation | Credentials › retrieve_by

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.

Parameters

credential_id: str

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.retrieve(
    "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.retrieve_by_name() ->

Credential

get/v5/credentials/name/{credential_name}

Retrieve a specific credential by its name.

Parameters

credential_name: str

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.retrieve_by_name(
    "credential_name",
)
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"
}