Get Credential by Name

credentials.retrieve_by_name() -> Credential

GET/v5/credentials/name/{credential_name}

Retrieve a specific credential by its name.

ParametersExpand Collapse

credential_name: str

ReturnsExpand Collapse

class Credential: …

id: str

created_at: datetime

formatdate-time

created_by_identity_type: Optional[str]

created_by_user_id: Optional[str]

credential_metadata: Optional[Dict[str, object]]

description: Optional[str]

name: str

type: str

updated_at: datetime

formatdate-time

object: Optional[str]

Get Credential by Name

import os
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
credential = client.credentials.retrieve_by_name(
    "credential_name",
)
print(credential.id)

{
  "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"
}

Returns Examples

{
  "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"
}