@netzreich/openstack-clients
Version:
Openstack Client generated via OpenAPI Spec via openapi-generator
1,892 lines (1,827 loc) • 444 kB
YAML
openapi: 3.1.0
info:
title: OpenStack Identity API
description: |-
Identity API provided by Keystone service
version: '3.14'
paths:
/:
get:
description: |-
GET operation on /
operationId: versions:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/RootGetResponse'
tags:
- version
head:
description: |-
HEAD operation on /
operationId: versions:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- version
/v3:
get:
description: |-
GET operation on /v3
operationId: version:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/RootGetResponse'
tags:
- v3
head:
description: |-
HEAD operation on /v3
operationId: version:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- v3
/v3/auth/projects:
get:
description: |-
Get possible project scopes for token.
GET/HEAD /v3/auth/projects
GET/HEAD /v3/OS-FEDERATION/projects
operationId: auth/projects:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AuthProjectsGetResponse'
tags:
- auth
head:
description: |-
Get possible project scopes for token.
GET/HEAD /v3/auth/projects
GET/HEAD /v3/OS-FEDERATION/projects
operationId: auth/projects:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- auth
/v3/OS-FEDERATION/projects:
get:
description: |-
Get possible project scopes for token.
GET/HEAD /v3/auth/projects
GET/HEAD /v3/OS-FEDERATION/projects
operationId: OS-FEDERATION/projects:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/Os_FederationProjectsGetResponse'
tags:
- OS-FEDERATION
deprecated: true
head:
description: |-
Get possible project scopes for token.
GET/HEAD /v3/auth/projects
GET/HEAD /v3/OS-FEDERATION/projects
operationId: OS-FEDERATION/projects:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- OS-FEDERATION
deprecated: true
/v3/auth/domains:
get:
description: |-
Get possible domain scopes for token.
GET/HEAD /v3/auth/domains
GET/HEAD /v3/OS-FEDERATION/domains
operationId: auth/domains:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AuthDomainsGetResponse'
tags:
- auth
head:
description: |-
Get possible domain scopes for token.
GET/HEAD /v3/auth/domains
GET/HEAD /v3/OS-FEDERATION/domains
operationId: auth/domains:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- auth
/v3/OS-FEDERATION/domains:
get:
description: |-
Get possible domain scopes for token.
GET/HEAD /v3/auth/domains
GET/HEAD /v3/OS-FEDERATION/domains
operationId: OS-FEDERATION/domains:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/Os_FederationDomainsGetResponse'
tags:
- OS-FEDERATION
deprecated: true
head:
description: |-
Get possible domain scopes for token.
GET/HEAD /v3/auth/domains
GET/HEAD /v3/OS-FEDERATION/domains
operationId: OS-FEDERATION/domains:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- OS-FEDERATION
deprecated: true
/v3/auth/system:
get:
description: |-
Get possible system scopes for token.
GET/HEAD /v3/auth/system
operationId: auth/system:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AuthSystemGetResponse'
tags:
- auth
head:
description: |-
Get possible system scopes for token.
GET/HEAD /v3/auth/system
operationId: auth/system:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- auth
/v3/auth/catalog:
get:
description: |-
Get service catalog for token.
GET/HEAD /v3/auth/catalog
operationId: auth/catalog:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AuthCatalogGetResponse'
tags:
- auth
head:
description: |-
Get service catalog for token.
GET/HEAD /v3/auth/catalog
operationId: auth/catalog:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- auth
/v3/auth/tokens/OS-PKI/revoked:
get:
description: |-
Deprecated; get revoked token list.
GET/HEAD /v3/auth/tokens/OS-PKI/revoked
operationId: auth/tokens/OS-PKI/revoked:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AuthTokensOs_PkiRevokedGetResponse'
tags:
- auth
head:
description: |-
Deprecated; get revoked token list.
GET/HEAD /v3/auth/tokens/OS-PKI/revoked
operationId: auth/tokens/OS-PKI/revoked:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- auth
/v3/auth/tokens:
get:
parameters:
- $ref: '#/components/parameters/X-Subject-Token'
description: |-
Validate a token.
HEAD/GET /v3/auth/tokens
operationId: auth/tokens:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AuthTokensGetResponse'
headers:
X-Subject-Token:
$ref: '#/components/headers/X-Subject-Token'
tags:
- auth
post:
description: |-
Issue a token.
POST /v3/auth/tokens
operationId: auth/tokens:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuthTokensPostRequest'
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AuthTokensPostResponse'
headers:
X-Subject-Token:
$ref: '#/components/headers/X-Subject-Token'
'401':
description: Unauthorized
headers:
Openstack-Auth-Receipt:
$ref: '#/components/headers/Openstack-Auth-Receipt'
content:
application/json:
schema:
$ref: '#/components/schemas/AuthReceiptSchema'
tags:
- auth
security: []
delete:
description: |-
Revoke a token.
DELETE /v3/auth/tokens
operationId: auth/tokens:delete
responses:
'403':
description: Error
'404':
description: Error
'204':
description: Ok
headers: {}
tags:
- auth
head:
description: |-
Validate a token.
HEAD/GET /v3/auth/tokens
operationId: auth/tokens:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
headers: {}
tags:
- auth
/v3/auth/OS-FEDERATION/saml2:
get:
description: |-
GET operation on /v3/auth/OS-FEDERATION/saml2
operationId: auth/OS-FEDERATION/saml2:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AuthOs_FederationSaml2GetResponse'
tags:
- auth
post:
description: |-
Exchange a scoped token for a SAML assertion.
POST /v3/auth/OS-FEDERATION/saml2
operationId: auth/OS-FEDERATION/saml2:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuthOs_FederationSaml2PostRequest'
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
text/xml:
schema:
$ref: '#/components/schemas/AuthOs_FederationSaml2PostResponse'
tags:
- auth
head:
description: |-
HEAD operation on /v3/auth/OS-FEDERATION/saml2
operationId: auth/OS-FEDERATION/saml2:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- auth
/v3/auth/OS-FEDERATION/saml2/ecp:
get:
description: |-
GET operation on /v3/auth/OS-FEDERATION/saml2/ecp
operationId: auth/OS-FEDERATION/saml2/ecp:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AuthOs_FederationSaml2EcpGetResponse'
tags:
- auth
post:
description: |-
Exchange a scoped token for an ECP assertion.
POST /v3/auth/OS-FEDERATION/saml2/ecp
operationId: auth/OS-FEDERATION/saml2/ecp:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuthOs_FederationSaml2EcpPostRequest'
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
text/xml:
schema:
$ref: '#/components/schemas/AuthOs_FederationSaml2EcpPostResponse'
tags:
- auth
head:
description: |-
HEAD operation on /v3/auth/OS-FEDERATION/saml2/ecp
operationId: auth/OS-FEDERATION/saml2/ecp:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- auth
/v3/auth/OS-FEDERATION/websso/{protocol_id}:
parameters:
- $ref: '#/components/parameters/auth_OS_FEDERATION_websso_protocol_id'
get:
description: |-
GET operation on /v3/auth/OS-FEDERATION/websso/{protocol_id}
operationId: auth/OS-FEDERATION/websso/protocol_id:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AuthOs_FederationWebssoGetResponse'
tags:
- auth
post:
description: |-
POST operation on /v3/auth/OS-FEDERATION/websso/{protocol_id}
operationId: auth/OS-FEDERATION/websso/protocol_id:post
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AuthOs_FederationWebssoPostResponse'
tags:
- auth
head:
description: |-
HEAD operation on /v3/auth/OS-FEDERATION/websso/{protocol_id}
operationId: auth/OS-FEDERATION/websso/protocol_id:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- auth
/v3/auth/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}/websso:
parameters:
- $ref: '#/components/parameters/auth_OS_FEDERATION_identity_providers_protocols_websso_idp_id'
- $ref: '#/components/parameters/auth_OS_FEDERATION_identity_providers_protocols_websso_protocol_id'
get:
description: |-
GET operation on /v3/auth/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}/websso
operationId: auth/OS-FEDERATION/identity_providers/idp_id/protocols/protocol_id/websso:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AuthOs_FederationIdentity_ProvidersProtocolsWebssoGetResponse'
tags:
- auth
post:
description: |-
POST operation on /v3/auth/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}/websso
operationId: auth/OS-FEDERATION/identity_providers/idp_id/protocols/protocol_id/websso:post
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/AuthOs_FederationIdentity_ProvidersProtocolsWebssoPostResponse'
tags:
- auth
head:
description: |-
HEAD operation on /v3/auth/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}/websso
operationId: auth/OS-FEDERATION/identity_providers/idp_id/protocols/protocol_id/websso:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- auth
/v3/credentials/{credential_id}:
parameters:
- $ref: '#/components/parameters/credentials_credential_id'
get:
description: |-
GET operation on /v3/credentials/{credential_id}
operationId: credentials/credential_id:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialGetResponse'
tags:
- credentials
delete:
description: |-
DELETE operation on /v3/credentials/{credential_id}
operationId: credentials/credential_id:delete
responses:
'403':
description: Error
'404':
description: Error
'204':
description: Ok
tags:
- credentials
patch:
description: |-
PATCH operation on /v3/credentials/{credential_id}
operationId: credentials/credential_id:patch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialPatchRequest'
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialPatchResponse'
tags:
- credentials
head:
description: |-
HEAD operation on /v3/credentials/{credential_id}
operationId: credentials/credential_id:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- credentials
/v3/credentials:
get:
description: |-
GET operation on /v3/credentials
operationId: credentials:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialsGetResponse'
tags:
- credentials
post:
description: |-
POST operation on /v3/credentials
operationId: credentials:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialsPostRequest'
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialsPostResponse'
tags:
- credentials
head:
description: |-
HEAD operation on /v3/credentials
operationId: credentials:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- credentials
/v3/domains/{domain_id}:
parameters:
- $ref: '#/components/parameters/domains_domain_id'
get:
description: |-
Get domain or list domains.
GET/HEAD /v3/domains
GET/HEAD /v3/domains/{domain_id}
operationId: domains/domain_id:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/Domain'
tags:
- domains
delete:
description: |-
Delete domain.
DELETE /v3/domains/{domain_id}
operationId: domains/domain_id:delete
responses:
'403':
description: Error
'404':
description: Error
'204':
description: Ok
tags:
- domains
patch:
description: |-
Update domain.
PATCH /v3/domains/{domain_id}
operationId: domains/domain_id:patch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Domain'
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/Domain'
tags:
- domains
head:
description: |-
Get domain or list domains.
GET/HEAD /v3/domains
GET/HEAD /v3/domains/{domain_id}
operationId: domains/domain_id:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- domains
/v3/domains:
get:
parameters:
- $ref: '#/components/parameters/domain_name'
- $ref: '#/components/parameters/domain_enabled'
description: |-
Get domain or list domains.
GET/HEAD /v3/domains
GET/HEAD /v3/domains/{domain_id}
operationId: domains:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/DomainsGetResponse'
tags:
- domains
post:
description: |-
Create domain.
POST /v3/domains
operationId: domains:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Domain'
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/Domain'
tags:
- domains
head:
description: |-
Get domain or list domains.
GET/HEAD /v3/domains
GET/HEAD /v3/domains/{domain_id}
operationId: domains:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- domains
/v3/domains/{domain_id}/config:
parameters:
- $ref: '#/components/parameters/domains_config_domain_id'
get:
description: |-
Check if config option exists.
GET/HEAD /v3/domains/{domain_id}/config
GET/HEAD /v3/domains/{domain_id}/config/{group}
GET/HEAD /v3/domains/{domain_id}/config/{group}/{option}
operationId: domains/domain_id/config:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfig'
tags:
- domain-configuration
delete:
description: |-
Delete domain config.
DELETE /v3/domains/{domain_id}/config
DELETE /v3/domains/{domain_id}/config/{group}
DELETE /v3/domains/{domain_id}/config/{group}/{option}
operationId: domains/domain_id/config:delete
responses:
'403':
description: Error
'404':
description: Error
'204':
description: Ok
tags:
- domain-configuration
put:
description: |-
Create domain config.
PUT /v3/domains/{domain_id}/config
operationId: domains/domain_id/config:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfig'
responses:
'403':
description: Error
'404':
description: Error
'201':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfig'
tags:
- domain-configuration
patch:
description: |-
Update domain config option.
PATCH /v3/domains/{domain_id}/config
PATCH /v3/domains/{domain_id}/config/{group}
PATCH /v3/domains/{domain_id}/config/{group}/{option}
operationId: domains/domain_id/config:patch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfig'
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfig'
tags:
- domain-configuration
head:
description: |-
Check if config option exists.
GET/HEAD /v3/domains/{domain_id}/config
GET/HEAD /v3/domains/{domain_id}/config/{group}
GET/HEAD /v3/domains/{domain_id}/config/{group}/{option}
operationId: domains/domain_id/config:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- domain-configuration
/v3/domains/{domain_id}/config/{group}:
parameters:
- $ref: '#/components/parameters/domains_config_domain_id'
- $ref: '#/components/parameters/domains_config_group'
get:
description: |-
Check if config option exists.
GET/HEAD /v3/domains/{domain_id}/config
GET/HEAD /v3/domains/{domain_id}/config/{group}
GET/HEAD /v3/domains/{domain_id}/config/{group}/{option}
operationId: domains/domain_id/config/group:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfigGroup'
tags:
- domain-configuration
delete:
description: |-
Delete domain config.
DELETE /v3/domains/{domain_id}/config
DELETE /v3/domains/{domain_id}/config/{group}
DELETE /v3/domains/{domain_id}/config/{group}/{option}
operationId: domains/domain_id/config/group:delete
responses:
'403':
description: Error
'404':
description: Error
'204':
description: Ok
tags:
- domain-configuration
patch:
description: |-
Update domain config option.
PATCH /v3/domains/{domain_id}/config
PATCH /v3/domains/{domain_id}/config/{group}
PATCH /v3/domains/{domain_id}/config/{group}/{option}
operationId: domains/domain_id/config/group:patch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfigGroup'
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfigGroup'
tags:
- domain-configuration
head:
description: |-
Check if config option exists.
GET/HEAD /v3/domains/{domain_id}/config
GET/HEAD /v3/domains/{domain_id}/config/{group}
GET/HEAD /v3/domains/{domain_id}/config/{group}/{option}
operationId: domains/domain_id/config/group:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- domain-configuration
/v3/domains/{domain_id}/config/{group}/{option}:
parameters:
- $ref: '#/components/parameters/domains_config_domain_id'
- $ref: '#/components/parameters/domains_config_group'
- $ref: '#/components/parameters/domains_config_option'
get:
description: |-
Check if config option exists.
GET/HEAD /v3/domains/{domain_id}/config
GET/HEAD /v3/domains/{domain_id}/config/{group}
GET/HEAD /v3/domains/{domain_id}/config/{group}/{option}
operationId: domains/domain_id/config/group/option:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfigGroupOption'
tags:
- domain-configuration
delete:
description: |-
Delete domain config.
DELETE /v3/domains/{domain_id}/config
DELETE /v3/domains/{domain_id}/config/{group}
DELETE /v3/domains/{domain_id}/config/{group}/{option}
operationId: domains/domain_id/config/group/option:delete
responses:
'403':
description: Error
'404':
description: Error
'204':
description: Ok
tags:
- domain-configuration
patch:
description: |-
Update domain config option.
PATCH /v3/domains/{domain_id}/config
PATCH /v3/domains/{domain_id}/config/{group}
PATCH /v3/domains/{domain_id}/config/{group}/{option}
operationId: domains/domain_id/config/group/option:patch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfigGroupOption'
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfigGroupOption'
tags:
- domain-configuration
head:
description: |-
Check if config option exists.
GET/HEAD /v3/domains/{domain_id}/config
GET/HEAD /v3/domains/{domain_id}/config/{group}
GET/HEAD /v3/domains/{domain_id}/config/{group}/{option}
operationId: domains/domain_id/config/group/option:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- domain-configuration
/v3/domains/config/default:
get:
description: |-
Get default domain config.
GET/HEAD /v3/domains/config/default
operationId: domains/config/default:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfig'
tags:
- domain-configuration
head:
description: |-
Get default domain config.
GET/HEAD /v3/domains/config/default
operationId: domains/config/default:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- domain-configuration
/v3/domains/config/{group}/default:
parameters:
- $ref: '#/components/parameters/domains_config_default_group'
get:
description: |-
Get default domain group config.
GET/HEAD /v3/domains/config/{group}/default
operationId: domains/config/group/default:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfigGroup'
tags:
- domain-configuration
head:
description: |-
Get default domain group config.
GET/HEAD /v3/domains/config/{group}/default
operationId: domains/config/group/default:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- domain-configuration
/v3/domains/config/{group}/{option}/default:
parameters:
- $ref: '#/components/parameters/domains_config_default_group'
- $ref: '#/components/parameters/domains_config_default_option'
get:
description: |-
Get default domain group option config.
GET/HEAD /v3/domains/config/{group}/{option}/default
operationId: domains/config/group/option/default:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfigGroupOption'
tags:
- domain-configuration
head:
description: |-
Get default domain group option config.
GET/HEAD /v3/domains/config/{group}/{option}/default
operationId: domains/config/group/option/default:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- domain-configuration
/v3/domains/{domain_id}/users/{user_id}/roles:
parameters:
- $ref: '#/components/parameters/domains_users_roles_domain_id'
- $ref: '#/components/parameters/domains_users_roles_user_id'
get:
description: |-
Get user grant.
GET/HEAD /v3/domains/{domain_id}/users/{user_id}/roles
operationId: domains/domain_id/users/user_id/roles:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/RolesInfos'
tags:
- roles
head:
description: |-
Get user grant.
GET/HEAD /v3/domains/{domain_id}/users/{user_id}/roles
operationId: domains/domain_id/users/user_id/roles:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- roles
/v3/domains/{domain_id}/users/{user_id}/roles/{role_id}:
parameters:
- $ref: '#/components/parameters/domains_users_roles_domain_id'
- $ref: '#/components/parameters/domains_users_roles_user_id'
- $ref: '#/components/parameters/domains_users_roles_role_id'
get:
description: |-
Check if a user has a specific role on the domain.
GET/HEAD /v3/domains/{domain_id}/users/{user_id}/roles/{role_id}
operationId: domains/domain_id/users/user_id/roles/role_id:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- roles
delete:
description: |-
Revoke a role from user on a domain.
DELETE /v3/domains/{domain_id}/users/{user_id}/roles/{role_id}
operationId: domains/domain_id/users/user_id/roles/role_id:delete
responses:
'403':
description: Error
'404':
description: Error
'204':
description: Ok
tags:
- roles
put:
description: |-
Create a role to a user on a domain.
PUT /v3/domains/{domain_id}/users/{user_id}/roles/{role_id}
operationId: domains/domain_id/users/user_id/roles/role_id:put
responses:
'403':
description: Error
'404':
description: Error
'201':
description: Ok
tags:
- roles
head:
description: |-
Check if a user has a specific role on the domain.
GET/HEAD /v3/domains/{domain_id}/users/{user_id}/roles/{role_id}
operationId: domains/domain_id/users/user_id/roles/role_id:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- roles
/v3/domains/{domain_id}/groups/{group_id}/roles:
parameters:
- $ref: '#/components/parameters/domains_groups_roles_domain_id'
- $ref: '#/components/parameters/domains_groups_roles_group_id'
get:
description: |-
List all domain grats for a specific group.
GET/HEAD /v3/domains/{domain_id}/groups/{group_id}/roles
operationId: domains/domain_id/groups/group_id/roles:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/RolesInfos'
tags:
- roles
head:
description: |-
List all domain grats for a specific group.
GET/HEAD /v3/domains/{domain_id}/groups/{group_id}/roles
operationId: domains/domain_id/groups/group_id/roles:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- roles
/v3/domains/{domain_id}/groups/{group_id}/roles/{role_id}:
parameters:
- $ref: '#/components/parameters/domains_groups_roles_domain_id'
- $ref: '#/components/parameters/domains_groups_roles_group_id'
- $ref: '#/components/parameters/domains_groups_roles_role_id'
get:
description: |-
Check if a group has a specific role on a domain.
GET/HEAD /v3/domains/{domain_id}/groups/{group_id}/roles/{role_id}
operationId: domains/domain_id/groups/group_id/roles/role_id:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- roles
delete:
description: |-
Revoke a role from a group on a domain.
DELETE /v3/domains/{domain_id}/groups/{group_id}/roles/{role_id}
operationId: domains/domain_id/groups/group_id/roles/role_id:delete
responses:
'403':
description: Error
'404':
description: Error
'204':
description: Ok
tags:
- roles
put:
description: |-
Grant a role to a group on a domain.
PUT /v3/domains/{domain_id}/groups/{group_id}/roles/{role_id}
operationId: domains/domain_id/groups/group_id/roles/role_id:put
responses:
'403':
description: Error
'404':
description: Error
'201':
description: Ok
tags:
- roles
head:
description: |-
Check if a group has a specific role on a domain.
GET/HEAD /v3/domains/{domain_id}/groups/{group_id}/roles/{role_id}
operationId: domains/domain_id/groups/group_id/roles/role_id:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- roles
/v3/ec2tokens:
get:
description: |-
GET operation on /v3/ec2tokens
operationId: ec2tokens:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/Ec2TokensGetResponse'
tags:
- ec2tokens
post:
description: |-
Authenticate ec2 token.
POST /v3/ec2tokens
operationId: ec2tokens:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Ec2TokensPostRequest'
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/Ec2TokensPostResponse'
tags:
- ec2tokens
head:
description: |-
HEAD operation on /v3/ec2tokens
operationId: ec2tokens:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- ec2tokens
/v3/endpoints/{endpoint_id}:
parameters:
- $ref: '#/components/parameters/endpoints_endpoint_id'
get:
description: |-
GET operation on /v3/endpoints/{endpoint_id}
operationId: endpoints/endpoint_id:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/Endpoint'
tags:
- endpoints
delete:
description: |-
DELETE operation on /v3/endpoints/{endpoint_id}
operationId: endpoints/endpoint_id:delete
responses:
'403':
description: Error
'404':
description: Error
'204':
description: Ok
tags:
- endpoints
patch:
description: |-
PATCH operation on /v3/endpoints/{endpoint_id}
operationId: endpoints/endpoint_id:patch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EndpointPatchRequest'
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/Endpoint'
tags:
- endpoints
head:
description: |-
HEAD operation on /v3/endpoints/{endpoint_id}
operationId: endpoints/endpoint_id:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- endpoints
/v3/endpoints:
get:
parameters:
- $ref: '#/components/parameters/endpoint_service_id'
- $ref: '#/components/parameters/endpoint_region_id'
- $ref: '#/components/parameters/endpoint_interface'
description: |-
GET operation on /v3/endpoints
operationId: endpoints:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/EndpointsGetResponse'
tags:
- endpoints
post:
description: |-
POST operation on /v3/endpoints
operationId: endpoints:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Endpoint'
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/Endpoint'
tags:
- endpoints
head:
description: |-
HEAD operation on /v3/endpoints
operationId: endpoints:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- endpoints
/v3/endpoints/{endpoint_id}/OS-ENDPOINT-POLICY/policy:
parameters:
- $ref: '#/components/parameters/endpoints_OS_ENDPOINT_POLICY_policy_endpoint_id'
get:
description: |-
GET operation on /v3/endpoints/{endpoint_id}/OS-ENDPOINT-POLICY/policy
operationId: endpoints/endpoint_id/OS-ENDPOINT-POLICY/policy:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/EndpointsOs_Endpoint_PolicyPolicyGetResponse'
tags:
- endpoints
deprecated: true
head:
description: |-
HEAD operation on /v3/endpoints/{endpoint_id}/OS-ENDPOINT-POLICY/policy
operationId: endpoints/endpoint_id/OS-ENDPOINT-POLICY/policy:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- endpoints
/v3/groups/{group_id}:
parameters:
- $ref: '#/components/parameters/groups_group_id'
get:
description: |-
GET operation on /v3/groups/{group_id}
operationId: groups/group_id:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
tags:
- groups
delete:
description: |-
Delete group.
DELETE /groups/{group_id}
operationId: groups/group_id:delete
responses:
'403':
description: Error
'404':
description: Error
'204':
description: Ok
tags:
- groups
patch:
description: |-
Update group.
PATCH /groups/{group_id}
operationId: groups/group_id:patch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
tags:
- groups
head:
description: |-
HEAD operation on /v3/groups/{group_id}
operationId: groups/group_id:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- groups
/v3/groups:
get:
parameters:
- $ref: '#/components/parameters/group_domain_id'
description: |-
GET operation on /v3/groups
operationId: groups:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/GroupsGetResponse'
tags:
- groups
post:
description: |-
Create group.
POST /groups
operationId: groups:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
tags:
- groups
head:
description: |-
HEAD operation on /v3/groups
operationId: groups:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- groups
/v3/groups/{group_id}/users:
parameters:
- $ref: '#/components/parameters/groups_users_group_id'
get:
parameters:
- $ref: '#/components/parameters/group_user_password_expires_at'
description: |-
Get list of users in group.
GET/HEAD /groups/{group_id}/users
operationId: groups/group_id/users:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/GroupsUsersGetResponse'
tags:
- groups
head:
description: |-
Get list of users in group.
GET/HEAD /groups/{group_id}/users
operationId: groups/group_id/users:head
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- groups
/v3/groups/{group_id}/users/{user_id}:
parameters:
- $ref: '#/components/parameters/groups_users_group_id'
- $ref: '#/components/parameters/groups_users_user_id'
get:
description: |-
Check if a user is in a group.
GET/HEAD /groups/{group_id}/users/{user_id}
operationId: groups/group_id/users/user_id:get
responses:
'403':
description: Error
'404':
description: Error
'200':
description: Ok
tags:
- groups
delete:
descript