PlatformCredential
One version of a platform credential of a Provider, from 1.28.0 one member of its key pool, masked: never the secret.
An object with 15 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
account | VendorAccountUsage | no | The last reading the api took of the vendor account behind the member (1.40.0): its status, the units used and allowed and the plan's tier. Absent when the api has taken none, when the vendor has no account request, or from an api older than 1.40.0. A member whose key authenticates can still read exhausted. |
active_sessions | integer | no | The Sessions whose unreleased reservations name the member as the first entry of a stage, across Organizations, when the api answered (1.28.0); a count only. The api from 1.28.0 always sends it. |
created_at | Timestamp | yes | |
created_by | ActorRef | yes | |
enabled | boolean | no | Whether admission may choose the member (1.28.0); a disabled member keeps its secret, serves no new Session and leaves running Sessions on it. The api from 1.28.0 always sends it, and a reader treats its absence as true. |
hint | string | yes | The last four characters of the secret, to tell keys apart; never more. |
id | PlatformCredentialId | no | The member's id (1.28.0), the key id the Session configuration and the trace name. The api from 1.28.0 always sends it. |
label | string or null | yes | An operator note, or null. |
max_concurrent_sessions | MaxConcurrentSessions or null | no | The member's cap on concurrent Sessions (1.28.0), or null for no cap. The api from 1.28.0 always sends it, and a reader treats its absence as null. |
object | "platform_credential" | yes | |
provider | ProviderId | yes | |
revision | integer | no | Counts the member's changes from 1 (1.28.0); PATCH takes it in If-Match. The api from 1.28.0 always sends it. |
revoked_at | Timestamp or null | yes | Null while the version is active. |
status | PlatformCredentialStatus | yes | |
version | integer | yes | Counts the Provider's credential entries from 1. |
Used by
The operations whose parameters, request body or responses name this shape directly.