List Secrets

Deprecated

client.Secrets.List(ctx, query) (*CursorPage[CloudSecret], error)

GET/v5/sgp/secrets

List secret metadata for the account. Values are never returned.

ParametersExpand Collapse

query SecretListParams

EndingBefore param.Field[string]Optional

Limit param.Field[int64]Optional

maximum10000

minimum1

SortBy param.Field[string]Optional

SortOrder param.Field[SortOrder]Optional

StartingAfter param.Field[string]Optional

ReturnsExpand Collapse

type CloudSecret struct{…}

API response model for a secret. Never includes the secret value.

ID string

The unique identifier of the entity.

AccountID string

The ID of the account that owns the given entity.

CloudSecretPath string

Full path in the cloud secret store.

CreatedAt Time

The date and time when the entity was created in ISO format.

formatdate-time

CreatedBy Identity

The identity that created the entity.

ID string

Type IdentityType

One of the following:

const IdentityTypeUser IdentityType = "user"

const IdentityTypeServiceAccount IdentityType = "service_account"

Object IdentityObjectOptional

Key string

Secret name, e.g. OPENAI_API_KEY.

Description stringOptional

Optional human-readable description of the secret.

Object CloudSecretObjectOptional

UpdatedAt TimeOptional

Timestamp of last update.

formatdate-time

UpdatedBy stringOptional

User who last updated the secret.

List Secrets

package main

import (
  "context"
  "fmt"

  "github.com/scaleapi/sgp-dev-go"
  "github.com/scaleapi/sgp-dev-go/option"
)

func main() {
  client := sgpdev.NewClient(
    option.WithAPIKey("My API Key"),
    option.WithAccountID("My Account ID"),
  )
  page, err := client.Secrets.List(context.TODO(), sgpdev.SecretListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "account_id": "account_id",
      "cloud_secret_path": "cloud_secret_path",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "key": "key",
      "description": "description",
      "object": "sgp_cloud_secret",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "updated_by": "updated_by"
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

Returns Examples

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "account_id": "account_id",
      "cloud_secret_path": "cloud_secret_path",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "key": "key",
      "description": "description",
      "object": "sgp_cloud_secret",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "updated_by": "updated_by"
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}