Check credential access

Read the credential's user, organisation, project binding and current permission scopes. This does not return the secret.

GET/api/customer/v1/credential

Permission: credential:read
Operation ID: getCredential

Example request

Set HCODE_BASE_URL and HCODE_API_KEY as shown in Getting started. Replace resource variables with your own IDs.

curl --request GET "$HCODE_BASE_URL/api/customer/v1/credential" \
  --header "Authorization: Bearer $HCODE_API_KEY"

Response

The JSON shape is defined in the response schema.

Response schema

{
  "type": "object",
  "properties": {
    "credentialId": {
      "type": "string"
    },
    "userId": {
      "type": "string"
    },
    "organizationId": {
      "type": "string"
    },
    "projectId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "role": {
      "type": "string"
    }
  },
  "required": [
    "credentialId",
    "userId",
    "organizationId",
    "projectId",
    "scopes",
    "role"
  ],
  "additionalProperties": true
}

See errors and retries for failure responses.