OpenStack v5.0.3 published on Wednesday, Feb 12, 2025 by Pulumi
openstack.identity.getAuthScope
Explore with Pulumi AI
Using getAuthScope
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getAuthScope(args: GetAuthScopeArgs, opts?: InvokeOptions): Promise<GetAuthScopeResult>
function getAuthScopeOutput(args: GetAuthScopeOutputArgs, opts?: InvokeOptions): Output<GetAuthScopeResult>
def get_auth_scope(name: Optional[str] = None,
region: Optional[str] = None,
set_token_id: Optional[bool] = None,
opts: Optional[InvokeOptions] = None) -> GetAuthScopeResult
def get_auth_scope_output(name: Optional[pulumi.Input[str]] = None,
region: Optional[pulumi.Input[str]] = None,
set_token_id: Optional[pulumi.Input[bool]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAuthScopeResult]
func GetAuthScope(ctx *Context, args *GetAuthScopeArgs, opts ...InvokeOption) (*GetAuthScopeResult, error)
func GetAuthScopeOutput(ctx *Context, args *GetAuthScopeOutputArgs, opts ...InvokeOption) GetAuthScopeResultOutput
> Note: This function is named GetAuthScope
in the Go SDK.
public static class GetAuthScope
{
public static Task<GetAuthScopeResult> InvokeAsync(GetAuthScopeArgs args, InvokeOptions? opts = null)
public static Output<GetAuthScopeResult> Invoke(GetAuthScopeInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAuthScopeResult> getAuthScope(GetAuthScopeArgs args, InvokeOptions options)
public static Output<GetAuthScopeResult> getAuthScope(GetAuthScopeArgs args, InvokeOptions options)
fn::invoke:
function: openstack:identity/getAuthScope:getAuthScope
arguments:
# arguments dictionary
The following arguments are supported:
- Name
This property is required. Changes to this property will trigger replacement.
- The name of the scope. This is an arbitrary name which is only used as a unique identifier so an actual token isn't used as the ID.
- Region
Changes to this property will trigger replacement.
- The region in which to obtain the V3 Identity client.
A Identity client is needed to retrieve tokens IDs. If omitted, the
region
argument of the provider is used. - Set
Token Id Changes to this property will trigger replacement.
- A boolean argument that determines whether to
export the current auth scope token ID. When set to
true
, thetoken_id
attribute will contain an unencrypted token that can be used for further API calls. Warning: please note that the leaked token may allow unauthorized access to other OpenStack services within the current auth scope, so use this option with caution.
- Name
This property is required. Changes to this property will trigger replacement.
- The name of the scope. This is an arbitrary name which is only used as a unique identifier so an actual token isn't used as the ID.
- Region
Changes to this property will trigger replacement.
- The region in which to obtain the V3 Identity client.
A Identity client is needed to retrieve tokens IDs. If omitted, the
region
argument of the provider is used. - Set
Token Id Changes to this property will trigger replacement.
- A boolean argument that determines whether to
export the current auth scope token ID. When set to
true
, thetoken_id
attribute will contain an unencrypted token that can be used for further API calls. Warning: please note that the leaked token may allow unauthorized access to other OpenStack services within the current auth scope, so use this option with caution.
- name
This property is required. Changes to this property will trigger replacement.
- The name of the scope. This is an arbitrary name which is only used as a unique identifier so an actual token isn't used as the ID.
- region
Changes to this property will trigger replacement.
- The region in which to obtain the V3 Identity client.
A Identity client is needed to retrieve tokens IDs. If omitted, the
region
argument of the provider is used. - set
Token Id Changes to this property will trigger replacement.
- A boolean argument that determines whether to
export the current auth scope token ID. When set to
true
, thetoken_id
attribute will contain an unencrypted token that can be used for further API calls. Warning: please note that the leaked token may allow unauthorized access to other OpenStack services within the current auth scope, so use this option with caution.
- name
This property is required. Changes to this property will trigger replacement.
- The name of the scope. This is an arbitrary name which is only used as a unique identifier so an actual token isn't used as the ID.
- region
Changes to this property will trigger replacement.
- The region in which to obtain the V3 Identity client.
A Identity client is needed to retrieve tokens IDs. If omitted, the
region
argument of the provider is used. - set
Token Id Changes to this property will trigger replacement.
- A boolean argument that determines whether to
export the current auth scope token ID. When set to
true
, thetoken_id
attribute will contain an unencrypted token that can be used for further API calls. Warning: please note that the leaked token may allow unauthorized access to other OpenStack services within the current auth scope, so use this option with caution.
- name
This property is required. Changes to this property will trigger replacement.
- The name of the scope. This is an arbitrary name which is only used as a unique identifier so an actual token isn't used as the ID.
- region
Changes to this property will trigger replacement.
- The region in which to obtain the V3 Identity client.
A Identity client is needed to retrieve tokens IDs. If omitted, the
region
argument of the provider is used. - set_
token_ id Changes to this property will trigger replacement.
- A boolean argument that determines whether to
export the current auth scope token ID. When set to
true
, thetoken_id
attribute will contain an unencrypted token that can be used for further API calls. Warning: please note that the leaked token may allow unauthorized access to other OpenStack services within the current auth scope, so use this option with caution.
- name
This property is required. Changes to this property will trigger replacement.
- The name of the scope. This is an arbitrary name which is only used as a unique identifier so an actual token isn't used as the ID.
- region
Changes to this property will trigger replacement.
- The region in which to obtain the V3 Identity client.
A Identity client is needed to retrieve tokens IDs. If omitted, the
region
argument of the provider is used. - set
Token Id Changes to this property will trigger replacement.
- A boolean argument that determines whether to
export the current auth scope token ID. When set to
true
, thetoken_id
attribute will contain an unencrypted token that can be used for further API calls. Warning: please note that the leaked token may allow unauthorized access to other OpenStack services within the current auth scope, so use this option with caution.
getAuthScope Result
The following output properties are available:
- Domain
Id string - The domain ID of the scope.
- Domain
Name string - The domain name of the scope.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the service.
- Project
Domain stringId - The domain ID of the project.
- Project
Domain stringName - The domain name of the project.
- Project
Id string - The project ID of the scope.
- Project
Name string - The project name of the scope.
- Region string
- The region of the endpoint.
- Roles
List<Pulumi.
Open Stack. Identity. Outputs. Get Auth Scope Role> - A list of roles in the current scope. See reference below.
- Service
Catalogs List<Pulumi.Open Stack. Identity. Outputs. Get Auth Scope Service Catalog> - A list of service catalog entries returned with the token.
- Token
Id string - The token ID of the scope.
- User
Domain stringId - The domain ID of the user.
- User
Domain stringName - The domain name of the user.
- User
Id string - The user ID the of the scope.
- User
Name string - The username of the scope.
- Set
Token boolId
- Domain
Id string - The domain ID of the scope.
- Domain
Name string - The domain name of the scope.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the service.
- Project
Domain stringId - The domain ID of the project.
- Project
Domain stringName - The domain name of the project.
- Project
Id string - The project ID of the scope.
- Project
Name string - The project name of the scope.
- Region string
- The region of the endpoint.
- Roles
[]Get
Auth Scope Role - A list of roles in the current scope. See reference below.
- Service
Catalogs []GetAuth Scope Service Catalog - A list of service catalog entries returned with the token.
- Token
Id string - The token ID of the scope.
- User
Domain stringId - The domain ID of the user.
- User
Domain stringName - The domain name of the user.
- User
Id string - The user ID the of the scope.
- User
Name string - The username of the scope.
- Set
Token boolId
- domain
Id String - The domain ID of the scope.
- domain
Name String - The domain name of the scope.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the service.
- project
Domain StringId - The domain ID of the project.
- project
Domain StringName - The domain name of the project.
- project
Id String - The project ID of the scope.
- project
Name String - The project name of the scope.
- region String
- The region of the endpoint.
- roles
List<Get
Auth Scope Role> - A list of roles in the current scope. See reference below.
- service
Catalogs List<GetAuth Scope Service Catalog> - A list of service catalog entries returned with the token.
- token
Id String - The token ID of the scope.
- user
Domain StringId - The domain ID of the user.
- user
Domain StringName - The domain name of the user.
- user
Id String - The user ID the of the scope.
- user
Name String - The username of the scope.
- set
Token BooleanId
- domain
Id string - The domain ID of the scope.
- domain
Name string - The domain name of the scope.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the service.
- project
Domain stringId - The domain ID of the project.
- project
Domain stringName - The domain name of the project.
- project
Id string - The project ID of the scope.
- project
Name string - The project name of the scope.
- region string
- The region of the endpoint.
- roles
Get
Auth Scope Role[] - A list of roles in the current scope. See reference below.
- service
Catalogs GetAuth Scope Service Catalog[] - A list of service catalog entries returned with the token.
- token
Id string - The token ID of the scope.
- user
Domain stringId - The domain ID of the user.
- user
Domain stringName - The domain name of the user.
- user
Id string - The user ID the of the scope.
- user
Name string - The username of the scope.
- set
Token booleanId
- domain_
id str - The domain ID of the scope.
- domain_
name str - The domain name of the scope.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the service.
- project_
domain_ strid - The domain ID of the project.
- project_
domain_ strname - The domain name of the project.
- project_
id str - The project ID of the scope.
- project_
name str - The project name of the scope.
- region str
- The region of the endpoint.
- roles
Sequence[Get
Auth Scope Role] - A list of roles in the current scope. See reference below.
- service_
catalogs Sequence[GetAuth Scope Service Catalog] - A list of service catalog entries returned with the token.
- token_
id str - The token ID of the scope.
- user_
domain_ strid - The domain ID of the user.
- user_
domain_ strname - The domain name of the user.
- user_
id str - The user ID the of the scope.
- user_
name str - The username of the scope.
- set_
token_ boolid
- domain
Id String - The domain ID of the scope.
- domain
Name String - The domain name of the scope.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the service.
- project
Domain StringId - The domain ID of the project.
- project
Domain StringName - The domain name of the project.
- project
Id String - The project ID of the scope.
- project
Name String - The project name of the scope.
- region String
- The region of the endpoint.
- roles List<Property Map>
- A list of roles in the current scope. See reference below.
- service
Catalogs List<Property Map> - A list of service catalog entries returned with the token.
- token
Id String - The token ID of the scope.
- user
Domain StringId - The domain ID of the user.
- user
Domain StringName - The domain name of the user.
- user
Id String - The user ID the of the scope.
- user
Name String - The username of the scope.
- set
Token BooleanId
Supporting Types
GetAuthScopeRole
GetAuthScopeServiceCatalog
- Endpoints
This property is required. List<Pulumi.Open Stack. Identity. Inputs. Get Auth Scope Service Catalog Endpoint> - A list of endpoints for the service.
- Id
This property is required. string - The ID of the endpoint.
- Name
This property is required. string - The name of the scope. This is an arbitrary name which is only used as a unique identifier so an actual token isn't used as the ID.
- Type
This property is required. string - The type of the service.
- Endpoints
This property is required. []GetAuth Scope Service Catalog Endpoint - A list of endpoints for the service.
- Id
This property is required. string - The ID of the endpoint.
- Name
This property is required. string - The name of the scope. This is an arbitrary name which is only used as a unique identifier so an actual token isn't used as the ID.
- Type
This property is required. string - The type of the service.
- endpoints
This property is required. List<GetAuth Scope Service Catalog Endpoint> - A list of endpoints for the service.
- id
This property is required. String - The ID of the endpoint.
- name
This property is required. String - The name of the scope. This is an arbitrary name which is only used as a unique identifier so an actual token isn't used as the ID.
- type
This property is required. String - The type of the service.
- endpoints
This property is required. GetAuth Scope Service Catalog Endpoint[] - A list of endpoints for the service.
- id
This property is required. string - The ID of the endpoint.
- name
This property is required. string - The name of the scope. This is an arbitrary name which is only used as a unique identifier so an actual token isn't used as the ID.
- type
This property is required. string - The type of the service.
- endpoints
This property is required. Sequence[GetAuth Scope Service Catalog Endpoint] - A list of endpoints for the service.
- id
This property is required. str - The ID of the endpoint.
- name
This property is required. str - The name of the scope. This is an arbitrary name which is only used as a unique identifier so an actual token isn't used as the ID.
- type
This property is required. str - The type of the service.
- endpoints
This property is required. List<Property Map> - A list of endpoints for the service.
- id
This property is required. String - The ID of the endpoint.
- name
This property is required. String - The name of the scope. This is an arbitrary name which is only used as a unique identifier so an actual token isn't used as the ID.
- type
This property is required. String - The type of the service.
GetAuthScopeServiceCatalogEndpoint
- Id
This property is required. string - The ID of the endpoint.
- Interface
This property is required. string - The interface of the endpoint.
- Region
This property is required. string - The region in which to obtain the V3 Identity client.
A Identity client is needed to retrieve tokens IDs. If omitted, the
region
argument of the provider is used. - Region
Id This property is required. string - The region ID of the endpoint.
- Url
This property is required. string - The URL of the endpoint.
- Id
This property is required. string - The ID of the endpoint.
- Interface
This property is required. string - The interface of the endpoint.
- Region
This property is required. string - The region in which to obtain the V3 Identity client.
A Identity client is needed to retrieve tokens IDs. If omitted, the
region
argument of the provider is used. - Region
Id This property is required. string - The region ID of the endpoint.
- Url
This property is required. string - The URL of the endpoint.
- id
This property is required. String - The ID of the endpoint.
- interface_
This property is required. String - The interface of the endpoint.
- region
This property is required. String - The region in which to obtain the V3 Identity client.
A Identity client is needed to retrieve tokens IDs. If omitted, the
region
argument of the provider is used. - region
Id This property is required. String - The region ID of the endpoint.
- url
This property is required. String - The URL of the endpoint.
- id
This property is required. string - The ID of the endpoint.
- interface
This property is required. string - The interface of the endpoint.
- region
This property is required. string - The region in which to obtain the V3 Identity client.
A Identity client is needed to retrieve tokens IDs. If omitted, the
region
argument of the provider is used. - region
Id This property is required. string - The region ID of the endpoint.
- url
This property is required. string - The URL of the endpoint.
- id
This property is required. str - The ID of the endpoint.
- interface
This property is required. str - The interface of the endpoint.
- region
This property is required. str - The region in which to obtain the V3 Identity client.
A Identity client is needed to retrieve tokens IDs. If omitted, the
region
argument of the provider is used. - region_
id This property is required. str - The region ID of the endpoint.
- url
This property is required. str - The URL of the endpoint.
- id
This property is required. String - The ID of the endpoint.
- interface
This property is required. String - The interface of the endpoint.
- region
This property is required. String - The region in which to obtain the V3 Identity client.
A Identity client is needed to retrieve tokens IDs. If omitted, the
region
argument of the provider is used. - region
Id This property is required. String - The region ID of the endpoint.
- url
This property is required. String - The URL of the endpoint.
Package Details
- Repository
- OpenStack pulumi/pulumi-openstack
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
openstack
Terraform Provider.