Identity & Access Management

Preview — pending review

This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.

Get one OpenStack API credential (no secret)

GET
/scopes/{scopeId}/iam/openstack-credentials/{credentialId}

One credential's metadata. Visibility as for the list; an invisible or unknown id is 404.

Authorization

bearerToken
headerAuthorizationBearer <token>

An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.

Path Parameters

scopeId*string

Opaque ownership+authorization scope resolving to tenant + subscription + project.

credentialId*string

Identifier of the credential.

Response Body

The credential (secret omitted).

application/json
  1. response

An OpenStack application credential minted by the platform (the secret is never included).

id*string
name*string
projectId*string

The portal project (scope) id.

owner*

Who the credential authenticates as (a member, or a service account).

profile*OpenStackCredentialProfile

full = Keystone member + load-balancer_member; readonly = reader + load-balancer_observer. Never more than the owner's projected roles on the project.

Value in"full""readonly"
roles*array<string>

The Keystone roles the credential carries.

status*OpenStackCredentialStatus

Lifecycle of an OpenStack API credential.

Value in"active""revoked""expired"
applicationCredentialId?|

The Keystone application credential id (not a secret).

expiresAt*string
Formatdate-time
createdAt*string
Formatdate-time
createdBy*string
lastUsedAt?|
Formatdate-time
revokedAt?|
Formatdate-time
revokeReason?|null
rotatedFromId?string|null
replacedById?string|null
deleteAfter?|

End of a rotation overlap window (the old credential is deleted then).

Formatdate-time
curl -X GET "https://example.com/scopes/string/iam/openstack-credentials/string"
{  "id": "string",  "name": "string",  "projectId": "string",  "owner": {    "kind": "user",    "id": "string"  },  "profile": "full",  "roles": [    "string"  ],  "status": "active",  "applicationCredentialId": "string",  "expiresAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "createdBy": "string",  "lastUsedAt": "2019-08-24T14:15:22Z",  "revokedAt": "2019-08-24T14:15:22Z",  "revokeReason": "user",  "rotatedFromId": "string",  "replacedById": "string",  "deleteAfter": "2019-08-24T14:15:22Z"}