UNPKG

@netzreich/openstack-clients

Version:

Openstack Client generated via OpenAPI Spec via openapi-generator

1,687 lines 833 kB
/** * OpenStack Identity API * Identity API provided by Keystone service * * The version of the OpenAPI document: 3.14 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * * @export * @interface AuthCatalogGetResponse */ export interface AuthCatalogGetResponse { /** * * @type {Array<AuthCatalogGetResponseCatalogInner>} * @memberof AuthCatalogGetResponse */ 'catalog'?: Array<AuthCatalogGetResponseCatalogInner>; } /** * * @export * @interface AuthCatalogGetResponseCatalogInner */ export interface AuthCatalogGetResponseCatalogInner { /** * * @type {Array<AuthCatalogGetResponseCatalogInnerEndpointsInner>} * @memberof AuthCatalogGetResponseCatalogInner */ 'endpoints'?: Array<AuthCatalogGetResponseCatalogInnerEndpointsInner>; /** * The UUID of the service to which the endpoint belongs. * @type {string} * @memberof AuthCatalogGetResponseCatalogInner */ 'id'?: string; /** * The service type, which describes the API implemented by the service * @type {string} * @memberof AuthCatalogGetResponseCatalogInner */ 'type'?: string; /** * The service name. * @type {string} * @memberof AuthCatalogGetResponseCatalogInner */ 'name'?: string; } /** * * @export * @interface AuthCatalogGetResponseCatalogInnerEndpointsInner */ export interface AuthCatalogGetResponseCatalogInnerEndpointsInner { /** * The endpoint UUID * @type {string} * @memberof AuthCatalogGetResponseCatalogInnerEndpointsInner */ 'id'?: string; /** * * @type {string} * @memberof AuthCatalogGetResponseCatalogInnerEndpointsInner */ 'interface'?: AuthCatalogGetResponseCatalogInnerEndpointsInnerInterfaceEnum; /** * Region name of the endpoint * @type {string} * @memberof AuthCatalogGetResponseCatalogInnerEndpointsInner */ 'region'?: string; /** * The endpoint url * @type {string} * @memberof AuthCatalogGetResponseCatalogInnerEndpointsInner */ 'url'?: string; } export declare const AuthCatalogGetResponseCatalogInnerEndpointsInnerInterfaceEnum: { readonly Public: "public"; readonly Internal: "internal"; readonly Admin: "admin"; }; export type AuthCatalogGetResponseCatalogInnerEndpointsInnerInterfaceEnum = typeof AuthCatalogGetResponseCatalogInnerEndpointsInnerInterfaceEnum[keyof typeof AuthCatalogGetResponseCatalogInnerEndpointsInnerInterfaceEnum]; /** * * @export * @interface AuthDomainsGetResponse */ export interface AuthDomainsGetResponse { /** * * @type {Array<AuthDomainsGetResponseDomainsInner>} * @memberof AuthDomainsGetResponse */ 'domains'?: Array<AuthDomainsGetResponseDomainsInner>; /** * Links to the resources in question. See [API Guide / Links and References](https://docs.openstack.org/api-guide/compute/links_and_references.html) for more info. * @type {Array<AuthProjectsGetResponseProjectsInnerLinksInner>} * @memberof AuthDomainsGetResponse */ 'links'?: Array<AuthProjectsGetResponseProjectsInnerLinksInner>; } /** * * @export * @interface AuthDomainsGetResponseDomainsInner */ export interface AuthDomainsGetResponseDomainsInner { /** * The ID of the domain. * @type {string} * @memberof AuthDomainsGetResponseDomainsInner */ 'id'?: string; /** * The name of the domain * @type {string} * @memberof AuthDomainsGetResponseDomainsInner */ 'name'?: string; /** * The description of the domain. * @type {string} * @memberof AuthDomainsGetResponseDomainsInner */ 'description'?: string; /** * If set to true, domain is enabled. If set to false, domain is disabled. * @type {boolean} * @memberof AuthDomainsGetResponseDomainsInner */ 'enabled'?: boolean; /** * Links to the resources in question. See [API Guide / Links and References](https://docs.openstack.org/api-guide/compute/links_and_references.html) for more info. * @type {Array<AuthProjectsGetResponseProjectsInnerLinksInner>} * @memberof AuthDomainsGetResponseDomainsInner */ 'links'?: Array<AuthProjectsGetResponseProjectsInnerLinksInner>; } /** * * @export * @interface AuthOsFederationIdentityProvidersProtocolsWebssoGetResponse */ export interface AuthOsFederationIdentityProvidersProtocolsWebssoGetResponse { /** * * @type {AuthOsFederationWebssoGetResponseToken} * @memberof AuthOsFederationIdentityProvidersProtocolsWebssoGetResponse */ 'token'?: AuthOsFederationWebssoGetResponseToken; } /** * * @export * @interface AuthOsFederationIdentityProvidersProtocolsWebssoPostResponse */ export interface AuthOsFederationIdentityProvidersProtocolsWebssoPostResponse { /** * * @type {AuthOsFederationWebssoGetResponseToken} * @memberof AuthOsFederationIdentityProvidersProtocolsWebssoPostResponse */ 'token'?: AuthOsFederationWebssoGetResponseToken; } /** * * @export * @interface AuthOsFederationSaml2EcpPostRequest */ export interface AuthOsFederationSaml2EcpPostRequest { /** * * @type {AuthTokensPostRequestAuth} * @memberof AuthOsFederationSaml2EcpPostRequest */ 'auth'?: AuthTokensPostRequestAuth; } /** * * @export * @interface AuthOsFederationSaml2PostRequest */ export interface AuthOsFederationSaml2PostRequest { /** * * @type {AuthTokensPostRequestAuth} * @memberof AuthOsFederationSaml2PostRequest */ 'auth'?: AuthTokensPostRequestAuth; } /** * * @export * @interface AuthOsFederationWebssoGetResponse */ export interface AuthOsFederationWebssoGetResponse { /** * * @type {AuthOsFederationWebssoGetResponseToken} * @memberof AuthOsFederationWebssoGetResponse */ 'token'?: AuthOsFederationWebssoGetResponseToken; } /** * * @export * @interface AuthOsFederationWebssoGetResponseToken */ export interface AuthOsFederationWebssoGetResponseToken { /** * A list of one or two audit IDs. An audit ID is a unique, randomly generated, URL-safe string that you can use to track a token. The first audit ID is the current audit ID for the token. The second audit ID is present for only re-scoped tokens and is the audit ID from the token before it was re-scoped. A re- scoped token is one that was exchanged for another token of the same or different scope. You can use these audit IDs to track the use of a token or chain of tokens across multiple requests and endpoints without exposing the token ID to non-privileged users. * @type {Array<string>} * @memberof AuthOsFederationWebssoGetResponseToken */ 'audit_ids'?: Array<string>; /** * A catalog object. * @type {Array<AuthCatalogGetResponseCatalogInner>} * @memberof AuthOsFederationWebssoGetResponseToken */ 'catalog'?: Array<AuthCatalogGetResponseCatalogInner>; /** * The date and time when the token expires. * @type {string} * @memberof AuthOsFederationWebssoGetResponseToken */ 'expires_at'?: string; /** * The date and time when the token was issued. * @type {string} * @memberof AuthOsFederationWebssoGetResponseToken */ 'issues_at'?: string; /** * The authentication methods, which are commonly password, token, or other methods. Indicates the accumulated set of authentication methods that were used to obtain the token. For example, if the token was obtained by password authentication, it contains password. Later, if the token is exchanged by using the token authentication method one or more times, the subsequently created tokens contain both password and token in their methods attribute. Unlike multi-factor authentication, the methods attribute merely indicates the methods that were used to authenticate the user in exchange for a token. The client is responsible for determining the total number of authentication factors. * @type {Array<string>} * @memberof AuthOsFederationWebssoGetResponseToken */ 'methods'?: Array<string>; /** * * @type {AuthTokensGetResponseTokenUser} * @memberof AuthOsFederationWebssoGetResponseToken */ 'user'?: AuthTokensGetResponseTokenUser; } /** * * @export * @interface AuthOsFederationWebssoPostResponse */ export interface AuthOsFederationWebssoPostResponse { /** * * @type {AuthOsFederationWebssoGetResponseToken} * @memberof AuthOsFederationWebssoPostResponse */ 'token'?: AuthOsFederationWebssoGetResponseToken; } /** * * @export * @interface AuthProjectsGetResponse */ export interface AuthProjectsGetResponse { /** * * @type {Array<AuthProjectsGetResponseProjectsInner>} * @memberof AuthProjectsGetResponse */ 'projects'?: Array<AuthProjectsGetResponseProjectsInner>; /** * Links to the resources in question. See [API Guide / Links and References](https://docs.openstack.org/api-guide/compute/links_and_references.html) for more info. * @type {Array<AuthProjectsGetResponseProjectsInnerLinksInner>} * @memberof AuthProjectsGetResponse */ 'links'?: Array<AuthProjectsGetResponseProjectsInnerLinksInner>; } /** * * @export * @interface AuthProjectsGetResponseProjectsInner */ export interface AuthProjectsGetResponseProjectsInner { /** * The ID of the domain for the project. * @type {string} * @memberof AuthProjectsGetResponseProjectsInner */ 'domain_id'?: string; /** * The ID of the project. * @type {string} * @memberof AuthProjectsGetResponseProjectsInner */ 'id'?: string; /** * The name of the project * @type {string} * @memberof AuthProjectsGetResponseProjectsInner */ 'name'?: string; /** * If set to true, project is enabled. If set to false, project is disabled. * @type {boolean} * @memberof AuthProjectsGetResponseProjectsInner */ 'enabled'?: boolean; /** * Links to the resources in question. See [API Guide / Links and References](https://docs.openstack.org/api-guide/compute/links_and_references.html) for more info. * @type {Array<AuthProjectsGetResponseProjectsInnerLinksInner>} * @memberof AuthProjectsGetResponseProjectsInner */ 'links'?: Array<AuthProjectsGetResponseProjectsInnerLinksInner>; } /** * Links to the resources in question. See [API Guide / Links and References](https://docs.openstack.org/api-guide/compute/links_and_references.html) for more info. * @export * @interface AuthProjectsGetResponseProjectsInnerLinksInner */ export interface AuthProjectsGetResponseProjectsInnerLinksInner { /** * * @type {string} * @memberof AuthProjectsGetResponseProjectsInnerLinksInner */ 'href'?: string; /** * * @type {string} * @memberof AuthProjectsGetResponseProjectsInnerLinksInner */ 'rel'?: string; } /** * * @export * @interface AuthReceiptSchema */ export interface AuthReceiptSchema { /** * * @type {AuthReceiptSchemaReceipt} * @memberof AuthReceiptSchema */ 'receipt'?: AuthReceiptSchemaReceipt; /** * A list of authentication rules that may be used with the auth receipt to complete the authentication process. * @type {Array<string>} * @memberof AuthReceiptSchema */ 'required_auth_methods'?: Array<string>; } /** * * @export * @interface AuthReceiptSchemaReceipt */ export interface AuthReceiptSchemaReceipt { /** * The date and time when the token expires. * @type {string} * @memberof AuthReceiptSchemaReceipt */ 'expires_at'?: string; /** * The date and time when the token was issued. * @type {string} * @memberof AuthReceiptSchemaReceipt */ 'issues_at'?: string; /** * The authentication methods, which are commonly password, token, or other methods. Indicates the accumulated set of authentication methods that were used to obtain the token. For example, if the token was obtained by password authentication, it contains password. Later, if the token is exchanged by using the token authentication method one or more times, the subsequently created tokens contain both password and token in their methods attribute. Unlike multi-factor authentication, the methods attribute merely indicates the methods that were used to authenticate the user in exchange for a token. The client is responsible for determining the total number of authentication factors. * @type {Array<string>} * @memberof AuthReceiptSchemaReceipt */ 'methods'?: Array<string>; /** * * @type {AuthTokensGetResponseTokenUser} * @memberof AuthReceiptSchemaReceipt */ 'user'?: AuthTokensGetResponseTokenUser; } /** * * @export * @interface AuthSystemGetResponse */ export interface AuthSystemGetResponse { /** * A list of systems to access based on role assignments. * @type {Array<{ [key: string]: boolean; }>} * @memberof AuthSystemGetResponse */ 'system'?: Array<{ [key: string]: boolean; }>; } /** * * @export * @interface AuthTokensGetResponse */ export interface AuthTokensGetResponse { /** * * @type {AuthTokensGetResponseToken} * @memberof AuthTokensGetResponse */ 'token'?: AuthTokensGetResponseToken; } /** * * @export * @interface AuthTokensGetResponseToken */ export interface AuthTokensGetResponseToken { /** * A list of one or two audit IDs. An audit ID is a unique, randomly generated, URL-safe string that you can use to track a token. The first audit ID is the current audit ID for the token. The second audit ID is present for only re-scoped tokens and is the audit ID from the token before it was re-scoped. A re- scoped token is one that was exchanged for another token of the same or different scope. You can use these audit IDs to track the use of a token or chain of tokens across multiple requests and endpoints without exposing the token ID to non-privileged users. * @type {Array<string>} * @memberof AuthTokensGetResponseToken */ 'audit_ids'?: Array<string>; /** * A catalog object. * @type {Array<AuthCatalogGetResponseCatalogInner>} * @memberof AuthTokensGetResponseToken */ 'catalog'?: Array<AuthCatalogGetResponseCatalogInner>; /** * The date and time when the token expires. * @type {string} * @memberof AuthTokensGetResponseToken */ 'expires_at'?: string; /** * The date and time when the token was issued. * @type {string} * @memberof AuthTokensGetResponseToken */ 'issues_at'?: string; /** * The authentication methods, which are commonly password, token, or other methods. Indicates the accumulated set of authentication methods that were used to obtain the token. For example, if the token was obtained by password authentication, it contains password. Later, if the token is exchanged by using the token authentication method one or more times, the subsequently created tokens contain both password and token in their methods attribute. Unlike multi-factor authentication, the methods attribute merely indicates the methods that were used to authenticate the user in exchange for a token. The client is responsible for determining the total number of authentication factors. * @type {Array<string>} * @memberof AuthTokensGetResponseToken */ 'methods'?: Array<string>; /** * * @type {AuthTokensGetResponseTokenUser} * @memberof AuthTokensGetResponseToken */ 'user'?: AuthTokensGetResponseTokenUser; /** * * @type {boolean} * @memberof AuthTokensGetResponseToken */ 'is_domain'?: boolean; /** * * @type {AuthTokensGetResponseTokenDomain} * @memberof AuthTokensGetResponseToken */ 'domain'?: AuthTokensGetResponseTokenDomain; /** * * @type {AuthTokensGetResponseTokenProject} * @memberof AuthTokensGetResponseToken */ 'project'?: AuthTokensGetResponseTokenProject; /** * A list of role objects * @type {Array<AuthTokensGetResponseTokenRolesInner>} * @memberof AuthTokensGetResponseToken */ 'roles'?: Array<AuthTokensGetResponseTokenRolesInner>; /** * A system object containing information about which parts of the system the token is scoped to. If the token is scoped to the entire deployment system, the system object will consist of {\"all\": true}. This is only included in tokens that are scoped to the system. * @type {{ [key: string]: boolean; }} * @memberof AuthTokensGetResponseToken */ 'system'?: { [key: string]: boolean; }; } /** * A domain object including the id and name representing the domain the token is scoped to. This is only included in tokens that are scoped to a domain. * @export * @interface AuthTokensGetResponseTokenDomain */ export interface AuthTokensGetResponseTokenDomain { /** * A domain UUID * @type {string} * @memberof AuthTokensGetResponseTokenDomain */ 'id'?: string; /** * A domain name * @type {string} * @memberof AuthTokensGetResponseTokenDomain */ 'name'?: string; } /** * A project object including the id, name and domain object representing the project the token is scoped to. This is only included in tokens that are scoped to a project. * @export * @interface AuthTokensGetResponseTokenProject */ export interface AuthTokensGetResponseTokenProject { /** * A user domain UUID * @type {string} * @memberof AuthTokensGetResponseTokenProject */ 'id'?: string; /** * A user domain name * @type {string} * @memberof AuthTokensGetResponseTokenProject */ 'name'?: string; } /** * * @export * @interface AuthTokensGetResponseTokenRolesInner */ export interface AuthTokensGetResponseTokenRolesInner { /** * A role UUID * @type {string} * @memberof AuthTokensGetResponseTokenRolesInner */ 'id'?: string; /** * A role name * @type {string} * @memberof AuthTokensGetResponseTokenRolesInner */ 'name'?: string; } /** * A user object * @export * @interface AuthTokensGetResponseTokenUser */ export interface AuthTokensGetResponseTokenUser { /** * A user UUID * @type {string} * @memberof AuthTokensGetResponseTokenUser */ 'id'?: string; /** * A user name * @type {string} * @memberof AuthTokensGetResponseTokenUser */ 'name'?: string; /** * * @type {AuthTokensGetResponseTokenUserDomain} * @memberof AuthTokensGetResponseTokenUser */ 'domain'?: AuthTokensGetResponseTokenUserDomain; /** * DateTime of the user password expiration * @type {string} * @memberof AuthTokensGetResponseTokenUser */ 'password_expires_at'?: string; /** * * @type {object} * @memberof AuthTokensGetResponseTokenUser */ 'OS-FEDERATION'?: object; } /** * * @export * @interface AuthTokensGetResponseTokenUserDomain */ export interface AuthTokensGetResponseTokenUserDomain { /** * A user domain UUID * @type {string} * @memberof AuthTokensGetResponseTokenUserDomain */ 'id'?: string; /** * A user domain name * @type {string} * @memberof AuthTokensGetResponseTokenUserDomain */ 'name'?: string; } /** * * @export * @interface AuthTokensPostRequest */ export interface AuthTokensPostRequest { /** * * @type {AuthTokensPostRequestAuth} * @memberof AuthTokensPostRequest */ 'auth'?: AuthTokensPostRequestAuth; } /** * An auth object. * @export * @interface AuthTokensPostRequestAuth */ export interface AuthTokensPostRequestAuth { /** * * @type {AuthTokensPostRequestAuthIdentity} * @memberof AuthTokensPostRequestAuth */ 'identity': AuthTokensPostRequestAuthIdentity; /** * * @type {AuthTokensPostRequestAuthScope} * @memberof AuthTokensPostRequestAuth */ 'scope'?: AuthTokensPostRequestAuthScope; } /** * An identity object. * @export * @interface AuthTokensPostRequestAuthIdentity */ export interface AuthTokensPostRequestAuthIdentity { /** * The authentication method. * @type {Array<string>} * @memberof AuthTokensPostRequestAuthIdentity */ 'methods': Array<AuthTokensPostRequestAuthIdentityMethodsEnum>; /** * * @type {AuthTokensPostRequestAuthIdentityPassword} * @memberof AuthTokensPostRequestAuthIdentity */ 'password'?: AuthTokensPostRequestAuthIdentityPassword; /** * * @type {AuthTokensPostRequestAuthIdentityToken} * @memberof AuthTokensPostRequestAuthIdentity */ 'token'?: AuthTokensPostRequestAuthIdentityToken; /** * * @type {AuthTokensPostRequestAuthIdentityTotp} * @memberof AuthTokensPostRequestAuthIdentity */ 'totp'?: AuthTokensPostRequestAuthIdentityTotp; /** * * @type {AuthTokensPostRequestAuthIdentityApplicationCredential} * @memberof AuthTokensPostRequestAuthIdentity */ 'application_credential'?: AuthTokensPostRequestAuthIdentityApplicationCredential; } export declare const AuthTokensPostRequestAuthIdentityMethodsEnum: { readonly Password: "password"; readonly Token: "token"; readonly Totp: "totp"; readonly ApplicationCredential: "application_credential"; }; export type AuthTokensPostRequestAuthIdentityMethodsEnum = typeof AuthTokensPostRequestAuthIdentityMethodsEnum[keyof typeof AuthTokensPostRequestAuthIdentityMethodsEnum]; /** * An application credential object. * @export * @interface AuthTokensPostRequestAuthIdentityApplicationCredential */ export interface AuthTokensPostRequestAuthIdentityApplicationCredential { /** * * @type {string} * @memberof AuthTokensPostRequestAuthIdentityApplicationCredential */ 'id'?: string; /** * * @type {string} * @memberof AuthTokensPostRequestAuthIdentityApplicationCredential */ 'name'?: string; /** * The secret for authenticating the application credential. * @type {string} * @memberof AuthTokensPostRequestAuthIdentityApplicationCredential */ 'secret': string; /** * * @type {AuthTokensPostRequestAuthIdentityApplicationCredentialUser} * @memberof AuthTokensPostRequestAuthIdentityApplicationCredential */ 'user'?: AuthTokensPostRequestAuthIdentityApplicationCredentialUser; } /** * A user object, required if an application credential is identified by name and not ID. * @export * @interface AuthTokensPostRequestAuthIdentityApplicationCredentialUser */ export interface AuthTokensPostRequestAuthIdentityApplicationCredentialUser { /** * The user ID * @type {string} * @memberof AuthTokensPostRequestAuthIdentityApplicationCredentialUser */ 'id'?: string; /** * The user name * @type {string} * @memberof AuthTokensPostRequestAuthIdentityApplicationCredentialUser */ 'name'?: string; /** * * @type {AuthTokensPostRequestAuthIdentityPasswordUserDomain} * @memberof AuthTokensPostRequestAuthIdentityApplicationCredentialUser */ 'domain'?: AuthTokensPostRequestAuthIdentityPasswordUserDomain; } /** * The password object, contains the authentication information. * @export * @interface AuthTokensPostRequestAuthIdentityPassword */ export interface AuthTokensPostRequestAuthIdentityPassword { /** * * @type {AuthTokensPostRequestAuthIdentityPasswordUser} * @memberof AuthTokensPostRequestAuthIdentityPassword */ 'user'?: AuthTokensPostRequestAuthIdentityPasswordUser; } /** * A `user` object * @export * @interface AuthTokensPostRequestAuthIdentityPasswordUser */ export interface AuthTokensPostRequestAuthIdentityPasswordUser { /** * User ID * @type {string} * @memberof AuthTokensPostRequestAuthIdentityPasswordUser */ 'id'?: string; /** * User Name * @type {string} * @memberof AuthTokensPostRequestAuthIdentityPasswordUser */ 'name'?: string; /** * User Password * @type {string} * @memberof AuthTokensPostRequestAuthIdentityPasswordUser */ 'password'?: string; /** * * @type {AuthTokensPostRequestAuthIdentityPasswordUserDomain} * @memberof AuthTokensPostRequestAuthIdentityPasswordUser */ 'domain'?: AuthTokensPostRequestAuthIdentityPasswordUserDomain; } /** * User Domain object * @export * @interface AuthTokensPostRequestAuthIdentityPasswordUserDomain */ export interface AuthTokensPostRequestAuthIdentityPasswordUserDomain { /** * User Domain ID * @type {string} * @memberof AuthTokensPostRequestAuthIdentityPasswordUserDomain */ 'id'?: string; /** * User Domain Name * @type {string} * @memberof AuthTokensPostRequestAuthIdentityPasswordUserDomain */ 'name'?: string; } /** * A `token` object * @export * @interface AuthTokensPostRequestAuthIdentityToken */ export interface AuthTokensPostRequestAuthIdentityToken { /** * Authorization Token value * @type {string} * @memberof AuthTokensPostRequestAuthIdentityToken */ 'id': string; } /** * Multi Factor Authentication information * @export * @interface AuthTokensPostRequestAuthIdentityTotp */ export interface AuthTokensPostRequestAuthIdentityTotp { /** * * @type {AuthTokensPostRequestAuthIdentityTotpUser} * @memberof AuthTokensPostRequestAuthIdentityTotp */ 'user': AuthTokensPostRequestAuthIdentityTotpUser; } /** * * @export * @interface AuthTokensPostRequestAuthIdentityTotpUser */ export interface AuthTokensPostRequestAuthIdentityTotpUser { /** * The user ID * @type {string} * @memberof AuthTokensPostRequestAuthIdentityTotpUser */ 'id'?: string; /** * The user name * @type {string} * @memberof AuthTokensPostRequestAuthIdentityTotpUser */ 'name'?: string; /** * * @type {AuthTokensPostRequestAuthIdentityPasswordUserDomain} * @memberof AuthTokensPostRequestAuthIdentityTotpUser */ 'domain'?: AuthTokensPostRequestAuthIdentityPasswordUserDomain; /** * MFA passcode * @type {string} * @memberof AuthTokensPostRequestAuthIdentityTotpUser */ 'passcode': string; } /** * The authorization scope, including the system (Since v3.10), a project, or a domain (Since v3.4). If multiple scopes are specified in the same request (e.g. project and domain or domain and system) an HTTP 400 Bad Request will be returned, as a token cannot be simultaneously scoped to multiple authorization targets. An ID is sufficient to uniquely identify a project but if a project is specified by name, then the domain of the project must also be specified in order to uniquely identify the project by name. A domain scope may be specified by either the domain’s ID or name with equivalent results. * @export * @interface AuthTokensPostRequestAuthScope */ export interface AuthTokensPostRequestAuthScope { /** * * @type {AuthTokensPostRequestAuthScopeProject} * @memberof AuthTokensPostRequestAuthScope */ 'project'?: AuthTokensPostRequestAuthScopeProject; /** * * @type {AuthTokensPostRequestAuthScopeDomain} * @memberof AuthTokensPostRequestAuthScope */ 'domain'?: AuthTokensPostRequestAuthScopeDomain; /** * * @type {AuthTokensPostRequestAuthScopeOSTRUSTTrust} * @memberof AuthTokensPostRequestAuthScope */ 'OS-TRUST:trust'?: AuthTokensPostRequestAuthScopeOSTRUSTTrust; /** * * @type {AuthTokensPostRequestAuthScopeSystem} * @memberof AuthTokensPostRequestAuthScope */ 'system'?: AuthTokensPostRequestAuthScopeSystem; } /** * * @export * @interface AuthTokensPostRequestAuthScopeDomain */ export interface AuthTokensPostRequestAuthScopeDomain { /** * Domain id * @type {string} * @memberof AuthTokensPostRequestAuthScopeDomain */ 'id'?: string; /** * Domain name * @type {string} * @memberof AuthTokensPostRequestAuthScopeDomain */ 'name'?: string; } /** * * @export * @interface AuthTokensPostRequestAuthScopeOSTRUSTTrust */ export interface AuthTokensPostRequestAuthScopeOSTRUSTTrust { /** * * @type {string} * @memberof AuthTokensPostRequestAuthScopeOSTRUSTTrust */ 'id'?: string; } /** * * @export * @interface AuthTokensPostRequestAuthScopeProject */ export interface AuthTokensPostRequestAuthScopeProject { /** * Project Name * @type {string} * @memberof AuthTokensPostRequestAuthScopeProject */ 'name'?: string; /** * Project Id * @type {string} * @memberof AuthTokensPostRequestAuthScopeProject */ 'id'?: string; /** * * @type {AuthTokensPostRequestAuthScopeProjectDomain} * @memberof AuthTokensPostRequestAuthScopeProject */ 'domain'?: AuthTokensPostRequestAuthScopeProjectDomain; } /** * * @export * @interface AuthTokensPostRequestAuthScopeProjectDomain */ export interface AuthTokensPostRequestAuthScopeProjectDomain { /** * Project domain Id * @type {string} * @memberof AuthTokensPostRequestAuthScopeProjectDomain */ 'id'?: string; /** * Project domain Name * @type {string} * @memberof AuthTokensPostRequestAuthScopeProjectDomain */ 'name'?: string; } /** * * @export * @interface AuthTokensPostRequestAuthScopeSystem */ export interface AuthTokensPostRequestAuthScopeSystem { /** * * @type {boolean} * @memberof AuthTokensPostRequestAuthScopeSystem */ 'all'?: boolean; } /** * * @export * @interface AuthTokensPostResponse */ export interface AuthTokensPostResponse { /** * * @type {AuthTokensGetResponseToken} * @memberof AuthTokensPostResponse */ 'token'?: AuthTokensGetResponseToken; } /** * * @export * @interface Domain */ export interface Domain { /** * * @type {DomainDomain} * @memberof Domain */ 'domain'?: DomainDomain; } /** * * @export * @interface DomainConfig */ export interface DomainConfig { /** * A config object. * @type {{ [key: string]: { [key: string]: any; }; }} * @memberof DomainConfig */ 'config'?: { [key: string]: { [key: string]: any; }; }; } /** * * @export * @interface DomainConfigGroup */ export interface DomainConfigGroup { /** * A config object. * @type {{ [key: string]: { [key: string]: any; }; }} * @memberof DomainConfigGroup */ 'config'?: { [key: string]: { [key: string]: any; }; }; } /** * * @export * @interface DomainConfigGroupOption */ export interface DomainConfigGroupOption { /** * * @type {{ [key: string]: any; }} * @memberof DomainConfigGroupOption */ 'config'?: { [key: string]: any; }; } /** * A domain object * @export * @interface DomainDomain */ export interface DomainDomain { /** * * @type {string} * @memberof DomainDomain */ 'id'?: string; /** * The name of the domain. * @type {string} * @memberof DomainDomain */ 'name'?: string; /** * The description of the domain. * @type {string} * @memberof DomainDomain */ 'description'?: string; /** * If set to true, domain is enabled. If set to false, domain is disabled. * @type {boolean} * @memberof DomainDomain */ 'enabled'?: boolean; /** * * @type {Array<string>} * @memberof DomainDomain */ 'tags'?: Array<string>; /** * The resource options for the domain. Available resource options are immutable. * @type {object} * @memberof DomainDomain */ 'options'?: object; } /** * * @export * @interface DomainsGetResponse */ export interface DomainsGetResponse { /** * * @type {Array<DomainDomain>} * @memberof DomainsGetResponse */ 'domains'?: Array<DomainDomain>; } /** * * @export * @interface Endpoint */ export interface Endpoint { /** * * @type {EndpointEndpoint} * @memberof Endpoint */ 'endpoint'?: EndpointEndpoint; } /** * * @export * @interface EndpointEndpoint */ export interface EndpointEndpoint { /** * Defines whether the service and its endpoints appear in the service catalog. * @type {boolean} * @memberof EndpointEndpoint */ 'enabled'?: boolean; /** * The UUID of the service to which the endpoint belongs. * @type {string} * @memberof EndpointEndpoint */ 'id'?: string; /** * The interface type, which describes the visibility of the Value is: - public. Visible by end users on a publicly available network interface. - internal. Visible by end users on an unmetered internal network interface. - admin. Visible by administrative users on a secure network interface. * @type {string} * @memberof EndpointEndpoint */ 'interface'?: EndpointEndpointInterfaceEnum; /** * The geographic location of the service endpoint. * @type {string} * @memberof EndpointEndpoint */ 'region'?: string; /** * The geographic location of the service * @type {string} * @memberof EndpointEndpoint */ 'region_id'?: string; /** * The UUID of the service to which the endpoint belongs. * @type {string} * @memberof EndpointEndpoint */ 'service_id'?: string; /** * The endpoint URL. * @type {string} * @memberof EndpointEndpoint */ 'url'?: string; } export declare const EndpointEndpointInterfaceEnum: { readonly Internal: "internal"; readonly Admin: "admin"; readonly Public: "public"; }; export type EndpointEndpointInterfaceEnum = typeof EndpointEndpointInterfaceEnum[keyof typeof EndpointEndpointInterfaceEnum]; /** * * @export * @interface EndpointsGetResponse */ export interface EndpointsGetResponse { /** * * @type {Array<EndpointEndpoint>} * @memberof EndpointsGetResponse */ 'endpoints'?: Array<EndpointEndpoint>; } /** * * @export * @interface Group */ export interface Group { /** * * @type {GroupGroup} * @memberof Group */ 'group'?: GroupGroup; } /** * * @export * @interface GroupGroup */ export interface GroupGroup { /** * * @type {string} * @memberof GroupGroup */ 'id'?: string; /** * * @type {string} * @memberof GroupGroup */ 'description'?: string | null; /** * * @type {string} * @memberof GroupGroup */ 'domain_id'?: string; /** * * @type {string} * @memberof GroupGroup */ 'name'?: string; } /** * * @export * @interface GroupsGetResponse */ export interface GroupsGetResponse { /** * * @type {Array<GroupGroup>} * @memberof GroupsGetResponse */ 'groups'?: Array<GroupGroup>; } /** * * @export * @interface GroupsUsersGetResponse */ export interface GroupsUsersGetResponse { /** * * @type {Array<GroupsUsersGetResponseUsersInner>} * @memberof GroupsUsersGetResponse */ 'users'?: Array<GroupsUsersGetResponseUsersInner>; } /** * * @export * @interface GroupsUsersGetResponseUsersInner */ export interface GroupsUsersGetResponseUsersInner { /** * * @type {string} * @memberof GroupsUsersGetResponseUsersInner */ 'id'?: string; /** * * @type {string} * @memberof GroupsUsersGetResponseUsersInner */ 'default_project_id'?: string | null; /** * * @type {string} * @memberof GroupsUsersGetResponseUsersInner */ 'description'?: string | null; /** * * @type {string} * @memberof GroupsUsersGetResponseUsersInner */ 'domain_id'?: string; /** * * @type {boolean} * @memberof GroupsUsersGetResponseUsersInner */ 'enabled'?: GroupsUsersGetResponseUsersInnerEnabledEnum; /** * * @type {Array<GroupsUsersGetResponseUsersInnerFederatedInner>} * @memberof GroupsUsersGetResponseUsersInner */ 'federated'?: Array<GroupsUsersGetResponseUsersInnerFederatedInner>; /** * * @type {string} * @memberof GroupsUsersGetResponseUsersInner */ 'name'?: string; /** * * @type {string} * @memberof GroupsUsersGetResponseUsersInner */ 'password'?: string | null; /** * * @type {GroupsUsersGetResponseUsersInnerOptions} * @memberof GroupsUsersGetResponseUsersInner */ 'options'?: GroupsUsersGetResponseUsersInnerOptions; } export declare const GroupsUsersGetResponseUsersInnerEnabledEnum: { readonly True: true; readonly False: false; readonly Null: any; }; export type GroupsUsersGetResponseUsersInnerEnabledEnum = typeof GroupsUsersGetResponseUsersInnerEnabledEnum[keyof typeof GroupsUsersGetResponseUsersInnerEnabledEnum]; /** * * @export * @interface GroupsUsersGetResponseUsersInnerFederatedInner */ export interface GroupsUsersGetResponseUsersInnerFederatedInner { /** * * @type {string} * @memberof GroupsUsersGetResponseUsersInnerFederatedInner */ 'idp_id': string; /** * * @type {Array<GroupsUsersGetResponseUsersInnerFederatedInnerProtocolsInner>} * @memberof GroupsUsersGetResponseUsersInnerFederatedInner */ 'protocols': Array<GroupsUsersGetResponseUsersInnerFederatedInnerProtocolsInner>; } /** * * @export * @interface GroupsUsersGetResponseUsersInnerFederatedInnerProtocolsInner */ export interface GroupsUsersGetResponseUsersInnerFederatedInnerProtocolsInner { /** * * @type {string} * @memberof GroupsUsersGetResponseUsersInnerFederatedInnerProtocolsInner */ 'protocol_id': string; /** * * @type {string} * @memberof GroupsUsersGetResponseUsersInnerFederatedInnerProtocolsInner */ 'unique_id': string; } /** * * @export * @interface GroupsUsersGetResponseUsersInnerOptions */ export interface GroupsUsersGetResponseUsersInnerOptions { [key: string]: any; /** * * @type {boolean} * @memberof GroupsUsersGetResponseUsersInnerOptions */ 'ignore_change_password_upon_first_use'?: GroupsUsersGetResponseUsersInnerOptionsIgnoreChangePasswordUponFirstUseEnum | null; /** * * @type {boolean} * @memberof GroupsUsersGetResponseUsersInnerOptions */ 'ignore_password_expiry'?: GroupsUsersGetResponseUsersInnerOptionsIgnorePasswordExpiryEnum | null; /** * * @type {boolean} * @memberof GroupsUsersGetResponseUsersInnerOptions */ 'ignore_lockout_failure_attempts'?: GroupsUsersGetResponseUsersInnerOptionsIgnoreLockoutFailureAttemptsEnum | null; /** * * @type {boolean} * @memberof GroupsUsersGetResponseUsersInnerOptions */ 'lock_password'?: GroupsUsersGetResponseUsersInnerOptionsLockPasswordEnum | null; /** * * @type {boolean} * @memberof GroupsUsersGetResponseUsersInnerOptions */ 'ignore_user_inactivity'?: GroupsUsersGetResponseUsersInnerOptionsIgnoreUserInactivityEnum | null; /** * * @type {Array<Array<string>>} * @memberof GroupsUsersGetResponseUsersInnerOptions */ 'multi_factor_auth_rules'?: Array<Array<string>>; /** * * @type {boolean} * @memberof GroupsUsersGetResponseUsersInnerOptions */ 'multi_factor_auth_enabled'?: GroupsUsersGetResponseUsersInnerOptionsMultiFactorAuthEnabledEnum | null; } export declare const GroupsUsersGetResponseUsersInnerOptionsIgnoreChangePasswordUponFirstUseEnum: { readonly True: true; readonly False: false; readonly Null: any; }; export type GroupsUsersGetResponseUsersInnerOptionsIgnoreChangePasswordUponFirstUseEnum = typeof GroupsUsersGetResponseUsersInnerOptionsIgnoreChangePasswordUponFirstUseEnum[keyof typeof GroupsUsersGetResponseUsersInnerOptionsIgnoreChangePasswordUponFirstUseEnum]; export declare const GroupsUsersGetResponseUsersInnerOptionsIgnorePasswordExpiryEnum: { readonly True: true; readonly False: false; readonly Null: any; }; export type GroupsUsersGetResponseUsersInnerOptionsIgnorePasswordExpiryEnum = typeof GroupsUsersGetResponseUsersInnerOptionsIgnorePasswordExpiryEnum[keyof typeof GroupsUsersGetResponseUsersInnerOptionsIgnorePasswordExpiryEnum]; export declare const GroupsUsersGetResponseUsersInnerOptionsIgnoreLockoutFailureAttemptsEnum: { readonly True: true; readonly False: false; readonly Null: any; }; export type GroupsUsersGetResponseUsersInnerOptionsIgnoreLockoutFailureAttemptsEnum = typeof GroupsUsersGetResponseUsersInnerOptionsIgnoreLockoutFailureAttemptsEnum[keyof typeof GroupsUsersGetResponseUsersInnerOptionsIgnoreLockoutFailureAttemptsEnum]; export declare const GroupsUsersGetResponseUsersInnerOptionsLockPasswordEnum: { readonly True: true; readonly False: false; readonly Null: any; }; export type GroupsUsersGetResponseUsersInnerOptionsLockPasswordEnum = typeof GroupsUsersGetResponseUsersInnerOptionsLockPasswordEnum[keyof typeof GroupsUsersGetResponseUsersInnerOptionsLockPasswordEnum]; export declare const GroupsUsersGetResponseUsersInnerOptionsIgnoreUserInactivityEnum: { readonly True: true; readonly False: false; readonly Null: any; }; export type GroupsUsersGetResponseUsersInnerOptionsIgnoreUserInactivityEnum = typeof GroupsUsersGetResponseUsersInnerOptionsIgnoreUserInactivityEnum[keyof typeof GroupsUsersGetResponseUsersInnerOptionsIgnoreUserInactivityEnum]; export declare const GroupsUsersGetResponseUsersInnerOptionsMultiFactorAuthEnabledEnum: { readonly True: true; readonly False: false; readonly Null: any; }; export type GroupsUsersGetResponseUsersInnerOptionsMultiFactorAuthEnabledEnum = typeof GroupsUsersGetResponseUsersInnerOptionsMultiFactorAuthEnabledEnum[keyof typeof GroupsUsersGetResponseUsersInnerOptionsMultiFactorAuthEnabledEnum]; /** * * @export * @interface OsFederationDomainsGetResponse */ export interface OsFederationDomainsGetResponse { /** * * @type {Array<AuthDomainsGetResponseDomainsInner>} * @memberof OsFederationDomainsGetResponse */ 'domains'?: Array<AuthDomainsGetResponseDomainsInner>; /** * Links to the resources in question. See [API Guide / Links and References](https://docs.openstack.org/api-guide/compute/links_and_references.html) for more info. * @type {Array<AuthProjectsGetResponseProjectsInnerLinksInner>} * @memberof OsFederationDomainsGetResponse */ 'links'?: Array<AuthProjectsGetResponseProjectsInnerLinksInner>; } /** * * @export * @interface OsFederationIdentityProviderGetResponse */ export interface OsFederationIdentityProviderGetResponse { /** * * @type {OsFederationIdentityProviderGetResponseIdentityProvider} * @memberof OsFederationIdentityProviderGetResponse */ 'identity_provider'?: OsFederationIdentityProviderGetResponseIdentityProvider; } /** * * @export * @interface OsFederationIdentityProviderGetResponseIdentityProvider */ export interface OsFederationIdentityProviderGetResponseIdentityProvider { /** * The Identity Provider unique ID * @type {string} * @memberof OsFederationIdentityProviderGetResponseIdentityProvider */ 'id'?: string; /** * The Identity Provider description * @type {string} * @memberof OsFederationIdentityProviderGetResponseIdentityProvider */ 'description'?: string; /** * The ID of a domain that is associated with the Identity Provider. * @type {string} * @memberof OsFederationIdentityProviderGetResponseIdentityProvider */ 'domain_id'?: string; /** * The length of validity in minutes for group memberships carried over through mapping and persisted in the database. * @type {number} * @memberof OsFederationIdentityProviderGetResponseIdentityProvider */ 'authorization_ttl'?: number; /** * Whether the Identity Provider is enabled or not * @type {boolean} * @memberof OsFederationIdentityProviderGetResponseIdentityProvider */ 'enabled'?: boolean; /** * List of the unique Identity Provider’s remote IDs * @type {Array<string>} * @memberof OsFederationIdentityProviderGetResponseIdentityProvider */ 'remote_ids'?: Array<string>; } /** * * @export * @interface OsFederationIdentityProviderPatchRequest */ export interface OsFederationIdentityProviderPatchRequest { /** * * @type {OsFederationIdentityProviderPatchRequestIdentityProvider} * @memberof OsFederationIdentityProviderPatchRequest */ 'identity_provider'?: OsFederationIdentityProviderPatchRequestIdentityProvider; } /** * * @export * @interface OsFederationIdentityProviderPatchRequestIdentityProvider */ export interface OsFederationIdentityProviderPatchRequestIdentityProvider { [key: string]: any; /** * * @type {boolean} * @memberof OsFederationIdentityProviderPatchRequestIdentityProvider */ 'enabled'?: OsFederationIdentityProviderPatchRequestIdentityProviderEnabledEnum; /** * * @type {string} * @memberof OsFederationIdentityProviderPatchRequestIdentityProvider */ 'description'?: string | null; /** * * @type {number} * @memberof OsFederationIdentityProviderPatchRequestIdentityProvider */ 'authorization_ttl'?: number | null; /** * * @type {Array<string>} * @memberof OsFederationIdentityProviderPatchRequestIdentityProvider */ 'remote_ids'?: Array<string>; } export declare const OsFederationIdentityProviderPatchRequestIdentityProviderEnabledEnum: { readonly True: true; readonly False: false; readonly Null: any; }; export type OsFederationIdentityProviderPatchRequestIdentityProviderEnabledEnum = typeof OsFederationIdentityProviderPatchRequestIdentityProviderEnabledEnum[keyof typeof OsFederationIdentityProviderPatchRequestIdentityProviderEnabledEnum]; /** * * @export * @interface OsFederationIdentityProviderPatchResponse */ export interface OsFederationIdentityProviderPatchResponse { /** * * @type {OsFederationIdentityProviderGetResponseIdentityProvider} * @memberof OsFederationIdentityProviderPatchResponse */ 'identity_provider'?: OsFederationIdentityProviderGetResponseIdentityProvider; } /** * * @export * @interface OsFederationIdentityProviderPutRequest */ export interface OsFederationIdentityProviderPutRequest { /** * * @type {OsFederationIdentityProviderPutRequestIdentityProvider} * @memberof OsFederationIdentityProviderPutRequest */ 'identity_provider'?: OsFederationIdentityProviderPutRequestIdentityProvider; } /** * * @export * @interface OsFederationIdentityProviderPutRequestIdentityProvider */ export interface OsFederationIdentityProviderPutRequestIdentityProvider { [key: string]: any; /** * * @type {boolean} * @memberof OsFederationIdentityProviderPutRequestIdentityProvider */ 'enabled'?: OsFederationIdentityProviderPutRequestIdentityProviderEnabledEnum; /** * * @type {string} * @memberof OsFederationIdentityProviderPutRequestIdentityProvider */ 'description'?: string | null; /** * * @type {string} * @memberof OsFederationIdentityProviderPutRequestIdentityProvider */ 'domain_id'?: string | null; /** * * @type {number} * @memberof OsFederationIdentityProviderPutRequestIdentityProvider */ 'authorization_ttl'?: number | null; /** * * @type {Array<string>} * @memberof OsFederationIdentityProviderPutRequestIdentityProvider */ 'remote_ids'?: Array<string>; } export declare const OsFederationIdentityProviderPutRequestIdentityProviderEnabledEnum: { readonly True: true; readonly False: false; readonly Null: any; }; export type OsFederationIdentityProviderPutRequestIdentityProviderEnabledEnum = typeof OsFederationIdentityProviderPutRequestIdentityProviderEnabledEnum[keyof typeof OsFederationIdentityProviderPutRequestIdentityProviderEnabledEnum]; /** * * @export * @interface OsFederationIdentityProviderPutResponse */ export interface OsFederationIdentityProviderPutResponse { /** * * @type {OsFederationIdentityProviderGetResponseIdentityProvider} * @memberof OsFederationIdentityProviderPutResponse */ 'identity_provider'?: OsFederationIdentityProviderGetResponseIdentityProvider; } /** * * @export * @interface OsFederationIdentityProvidersGetResponse */ export interface OsFederationIdentityProvidersGetResponse { /** * * @type {Array<OsFederationIdentityProviderGetResponseIdentityProvider>} * @memberof OsFederationIdentityProvidersGetResponse */ 'identity_providers'?: Array<OsFederationIdentityProviderGetResponseIdentityProvider>; } /** * * @export * @interface OsFederationIdentityProvidersProtocolGetResponse */ export interface OsFederationIdentityProv