1. Packages
  2. Openstack Provider
  3. API Docs
  4. identity
  5. getAuthScope
OpenStack v5.0.3 published on Wednesday, Feb 12, 2025 by Pulumi

openstack.identity.getAuthScope

Explore with Pulumi AI

OpenStack v5.0.3 published on Wednesday, Feb 12, 2025 by Pulumi

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>
Copy
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]
Copy
func GetAuthScope(ctx *Context, args *GetAuthScopeArgs, opts ...InvokeOption) (*GetAuthScopeResult, error)
func GetAuthScopeOutput(ctx *Context, args *GetAuthScopeOutputArgs, opts ...InvokeOption) GetAuthScopeResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetAuthScopeResult> getAuthScope(GetAuthScopeArgs args, InvokeOptions options)
public static Output<GetAuthScopeResult> getAuthScope(GetAuthScopeArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: openstack:identity/getAuthScope:getAuthScope
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name
This property is required.
Changes to this property will trigger replacement.
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.
Region Changes to this property will trigger replacement. 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.
SetTokenId Changes to this property will trigger replacement. bool
A boolean argument that determines whether to export the current auth scope token ID. When set to true, the token_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.
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.
Region Changes to this property will trigger replacement. 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.
SetTokenId Changes to this property will trigger replacement. bool
A boolean argument that determines whether to export the current auth scope token ID. When set to true, the token_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.
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.
region Changes to this property will trigger replacement. 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.
setTokenId Changes to this property will trigger replacement. Boolean
A boolean argument that determines whether to export the current auth scope token ID. When set to true, the token_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.
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.
region Changes to this property will trigger replacement. 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.
setTokenId Changes to this property will trigger replacement. boolean
A boolean argument that determines whether to export the current auth scope token ID. When set to true, the token_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.
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.
region Changes to this property will trigger replacement. 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.
set_token_id Changes to this property will trigger replacement. bool
A boolean argument that determines whether to export the current auth scope token ID. When set to true, the token_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.
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.
region Changes to this property will trigger replacement. 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.
setTokenId Changes to this property will trigger replacement. Boolean
A boolean argument that determines whether to export the current auth scope token ID. When set to true, the token_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:

DomainId string
The domain ID of the scope.
DomainName 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.
ProjectDomainId string
The domain ID of the project.
ProjectDomainName string
The domain name of the project.
ProjectId string
The project ID of the scope.
ProjectName string
The project name of the scope.
Region string
The region of the endpoint.
Roles List<Pulumi.OpenStack.Identity.Outputs.GetAuthScopeRole>
A list of roles in the current scope. See reference below.
ServiceCatalogs List<Pulumi.OpenStack.Identity.Outputs.GetAuthScopeServiceCatalog>
A list of service catalog entries returned with the token.
TokenId string
The token ID of the scope.
UserDomainId string
The domain ID of the user.
UserDomainName string
The domain name of the user.
UserId string
The user ID the of the scope.
UserName string
The username of the scope.
SetTokenId bool
DomainId string
The domain ID of the scope.
DomainName 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.
ProjectDomainId string
The domain ID of the project.
ProjectDomainName string
The domain name of the project.
ProjectId string
The project ID of the scope.
ProjectName string
The project name of the scope.
Region string
The region of the endpoint.
Roles []GetAuthScopeRole
A list of roles in the current scope. See reference below.
ServiceCatalogs []GetAuthScopeServiceCatalog
A list of service catalog entries returned with the token.
TokenId string
The token ID of the scope.
UserDomainId string
The domain ID of the user.
UserDomainName string
The domain name of the user.
UserId string
The user ID the of the scope.
UserName string
The username of the scope.
SetTokenId bool
domainId String
The domain ID of the scope.
domainName 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.
projectDomainId String
The domain ID of the project.
projectDomainName String
The domain name of the project.
projectId String
The project ID of the scope.
projectName String
The project name of the scope.
region String
The region of the endpoint.
roles List<GetAuthScopeRole>
A list of roles in the current scope. See reference below.
serviceCatalogs List<GetAuthScopeServiceCatalog>
A list of service catalog entries returned with the token.
tokenId String
The token ID of the scope.
userDomainId String
The domain ID of the user.
userDomainName String
The domain name of the user.
userId String
The user ID the of the scope.
userName String
The username of the scope.
setTokenId Boolean
domainId string
The domain ID of the scope.
domainName 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.
projectDomainId string
The domain ID of the project.
projectDomainName string
The domain name of the project.
projectId string
The project ID of the scope.
projectName string
The project name of the scope.
region string
The region of the endpoint.
roles GetAuthScopeRole[]
A list of roles in the current scope. See reference below.
serviceCatalogs GetAuthScopeServiceCatalog[]
A list of service catalog entries returned with the token.
tokenId string
The token ID of the scope.
userDomainId string
The domain ID of the user.
userDomainName string
The domain name of the user.
userId string
The user ID the of the scope.
userName string
The username of the scope.
setTokenId boolean
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_id str
The domain ID of the project.
project_domain_name str
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[GetAuthScopeRole]
A list of roles in the current scope. See reference below.
service_catalogs Sequence[GetAuthScopeServiceCatalog]
A list of service catalog entries returned with the token.
token_id str
The token ID of the scope.
user_domain_id str
The domain ID of the user.
user_domain_name str
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_id bool
domainId String
The domain ID of the scope.
domainName 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.
projectDomainId String
The domain ID of the project.
projectDomainName String
The domain name of the project.
projectId String
The project ID of the scope.
projectName 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.
serviceCatalogs List<Property Map>
A list of service catalog entries returned with the token.
tokenId String
The token ID of the scope.
userDomainId String
The domain ID of the user.
userDomainName String
The domain name of the user.
userId String
The user ID the of the scope.
userName String
The username of the scope.
setTokenId Boolean

Supporting Types

GetAuthScopeRole

RoleId This property is required. string
The ID of the role.
RoleName This property is required. string
The name of the role.
RoleId This property is required. string
The ID of the role.
RoleName This property is required. string
The name of the role.
roleId This property is required. String
The ID of the role.
roleName This property is required. String
The name of the role.
roleId This property is required. string
The ID of the role.
roleName This property is required. string
The name of the role.
role_id This property is required. str
The ID of the role.
role_name This property is required. str
The name of the role.
roleId This property is required. String
The ID of the role.
roleName This property is required. String
The name of the role.

GetAuthScopeServiceCatalog

Endpoints This property is required. List<Pulumi.OpenStack.Identity.Inputs.GetAuthScopeServiceCatalogEndpoint>
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. []GetAuthScopeServiceCatalogEndpoint
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<GetAuthScopeServiceCatalogEndpoint>
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. GetAuthScopeServiceCatalogEndpoint[]
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[GetAuthScopeServiceCatalogEndpoint]
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.
RegionId 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.
RegionId 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.
regionId 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.
regionId 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.
regionId 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.
OpenStack v5.0.3 published on Wednesday, Feb 12, 2025 by Pulumi