List credential profiles

GET

credential-profiles

curl --request GET \
  --url "https://api.bead.run/credential-profiles" \
  --header "X-API-Key: $BEAD_API_KEY"

from beadrun import Bead

client = Bead()
result = client.profiles.list()
client.close()

import { Bead } from "@beadrun/sdk";

const client = new Bead();
const result = await client.profiles.list();

{
  "response": [
    {
      "id": "<string>",
      "name": "<string>",
      "version": 123,
      "revoked": true
    }
  ]
}

Authentication

Send your scoped bearer token in the Authorization: Bearer <BEAD_TOKEN> header, or send your API key in X-API-Key.

curl --request GET \
  --url "https://api.bead.run/credential-profiles" \
  --header "X-API-Key: $BEAD_API_KEY"

from beadrun import Bead

client = Bead()
result = client.profiles.list()
client.close()

import { Bead } from "@beadrun/sdk";

const client = new Bead();
const result = await client.profiles.list();

Credential profile metadata ordered by name, limited to 1000 profiles.

object[]

Credential profiles visible to your organization.

Show Properties

string

required

Profile UUID.

string

required

Display name for the profile.

integer

required

Version incremented when credentials are replaced or revoked.

boolean

required

Whether delivery of this profile has been revoked.

Status	Meaning
401	Authentication credential is missing or rejected.
403	The credential lacks the required scope.
429	Request or resource admission limit exceeded (`admission_limit`). Follow limit.next_action and Retry-After when present.
500	Credential profile metadata could not be serialized.
503	Service or persistence is temporarily unavailable.

curl --request GET \
  --url "https://api.bead.run/credential-profiles" \
  --header "X-API-Key: $BEAD_API_KEY"

from beadrun import Bead

client = Bead()
result = client.profiles.list()
client.close()

import { Bead } from "@beadrun/sdk";

const client = new Bead();
const result = await client.profiles.list();

{
  "response": [
    {
      "id": "<string>",
      "name": "<string>",
      "version": 123,
      "revoked": true
    }
  ]
}