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.
Read the organisation's direct OpenStack API access switch
Whether direct OpenStack API access is switched on for the organisation that owns this project, who
changed it last, and how many API principals / active credentials exist.
Authorization: iam: read on the project.
Errors: 401; 403; 404 unknown/unreachable scope.
bearerTokenAuthorizationBearer <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.
scopeId*stringOpaque ownership+authorization scope resolving to tenant + subscription + project.
The switch state.
application/json- response
The organisation's direct OpenStack API access switch.
enabled*booleanchangedBy?string|nullchangedAt?|date-timeprincipals*integerAPI principals (Keystone users) of the organisation.
activeCredentials*integeroperatorLock?|Set while the platform operator has disabled the organisation's API access. Only the operator can lift it; until then the switch cannot be turned on and no credential can be created or rotated.
curl -X GET "https://example.com/scopes/string/iam/openstack-api-access"{ "enabled": true, "changedBy": "string", "changedAt": "2019-08-24T14:15:22Z", "principals": 0, "activeCredentials": 0, "operatorLock": { "lockedAt": "2019-08-24T14:15:22Z", "reason": "string" }}