Documentation | Credentials › List Credentials

Credentials

credentials

Methods

Create Credential ->

Credential

post/v5/credentials

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

Get Credential By ID ->

Credential

get/v5/credentials/{credential_id}

Retrieve a specific credential by its unique identifier.

Get Credential By Name ->

Credential

get/v5/credentials/name/{credential_name}

Retrieve a specific credential by its name.

Get Credential Secret By ID ->

CredentialSecret

post/v5/credentials/{credential_id}/secret

Retrieve the plaintext payload of a credential by its ID.

Get Credential Secret By Name ->

CredentialSecret

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

Retrieve the plaintext payload of a credential by its name.

List Credentials -> CursorPage<

Credential

get/v5/credentials

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

query Parameters

ending_before: string

Optional

limit: number

Optional

(maximum: 1000, minimum: 1, default: 100)

name: string

Optional

Filter credentials by name

sort_by: string

Optional

sort_order:

Optional

(default: "asc")

"asc"

"desc"

starting_after: string

Optional

Response fields

has_more: boolean

Whether there are more items left to be fetched.

items: Array<

Credential

total: number

The total of items that match the query. This is greater than or equal to the number of items returned.

limit: number

Optional

(default: 100)

The maximum number of items to return.

object: "list"

Optional

(default: "list")

Request example

curl https://api.egp.scale.com/v5/credentials \
    -H "x-api-key: $SGP_API_KEY"

200Example

{
  "has_more": true,
  "items": [
    {
      "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"
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

Update Credential ->

Credential

patch/v5/credentials/{credential_id}

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

Delete Credential -> { id, deleted, object }

delete/v5/credentials/{credential_id}

Permanently delete a credential and all its associated data.

Domain types

Credential = { id, created_at, created_by_identity_type, 7 more... }

CredentialSecret = { result, object }