1. Packages
  2. Ibm Provider
  3. API Docs
  4. getAppidTokenConfig
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getAppidTokenConfig

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Retrieve information about an IBM Cloud AppID Management Services token configuration. For more information, refer to Customizing AppID tokens.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const tc = ibm.getAppidTokenConfig({
        tenantId: _var.tenant_id,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    tc = ibm.get_appid_token_config(tenant_id=var["tenant_id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.LookupAppidTokenConfig(ctx, &ibm.LookupAppidTokenConfigArgs{
    			TenantId: _var.Tenant_id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var tc = Ibm.GetAppidTokenConfig.Invoke(new()
        {
            TenantId = @var.Tenant_id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetAppidTokenConfigArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var tc = IbmFunctions.getAppidTokenConfig(GetAppidTokenConfigArgs.builder()
                .tenantId(var_.tenant_id())
                .build());
    
        }
    }
    
    variables:
      tc:
        fn::invoke:
          function: ibm:getAppidTokenConfig
          arguments:
            tenantId: ${var.tenant_id}
    

    Using getAppidTokenConfig

    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 getAppidTokenConfig(args: GetAppidTokenConfigArgs, opts?: InvokeOptions): Promise<GetAppidTokenConfigResult>
    function getAppidTokenConfigOutput(args: GetAppidTokenConfigOutputArgs, opts?: InvokeOptions): Output<GetAppidTokenConfigResult>
    def get_appid_token_config(id: Optional[str] = None,
                               tenant_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetAppidTokenConfigResult
    def get_appid_token_config_output(id: Optional[pulumi.Input[str]] = None,
                               tenant_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetAppidTokenConfigResult]
    func LookupAppidTokenConfig(ctx *Context, args *LookupAppidTokenConfigArgs, opts ...InvokeOption) (*LookupAppidTokenConfigResult, error)
    func LookupAppidTokenConfigOutput(ctx *Context, args *LookupAppidTokenConfigOutputArgs, opts ...InvokeOption) LookupAppidTokenConfigResultOutput

    > Note: This function is named LookupAppidTokenConfig in the Go SDK.

    public static class GetAppidTokenConfig 
    {
        public static Task<GetAppidTokenConfigResult> InvokeAsync(GetAppidTokenConfigArgs args, InvokeOptions? opts = null)
        public static Output<GetAppidTokenConfigResult> Invoke(GetAppidTokenConfigInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAppidTokenConfigResult> getAppidTokenConfig(GetAppidTokenConfigArgs args, InvokeOptions options)
    public static Output<GetAppidTokenConfigResult> getAppidTokenConfig(GetAppidTokenConfigArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getAppidTokenConfig:getAppidTokenConfig
      arguments:
        # arguments dictionary

    The following arguments are supported:

    TenantId string
    The AppID instance GUID
    Id string
    TenantId string
    The AppID instance GUID
    Id string
    tenantId String
    The AppID instance GUID
    id String
    tenantId string
    The AppID instance GUID
    id string
    tenant_id str
    The AppID instance GUID
    id str
    tenantId String
    The AppID instance GUID
    id String

    getAppidTokenConfig Result

    The following output properties are available:

    AccessTokenClaims List<GetAppidTokenConfigAccessTokenClaim>
    (Set of Object) A set of objects that are created when claims that are related to access tokens are mapped
    AccessTokenExpiresIn double
    (Number) The length of time for which access tokens are valid in seconds
    AnonymousAccessEnabled bool
    (Bool) Enable anonymous access
    AnonymousTokenExpiresIn double
    (Number) The length of time for which an anonymous token is valid in seconds
    Id string
    IdTokenClaims List<GetAppidTokenConfigIdTokenClaim>
    (Set of Object) A set of objects that are created when claims that are related to identity tokens are mapped
    RefreshTokenEnabled bool
    (Bool) Enable refresh token
    RefreshTokenExpiresIn double
    (Number) The length of time for which refresh tokens are valid in seconds
    TenantId string
    AccessTokenClaims []GetAppidTokenConfigAccessTokenClaim
    (Set of Object) A set of objects that are created when claims that are related to access tokens are mapped
    AccessTokenExpiresIn float64
    (Number) The length of time for which access tokens are valid in seconds
    AnonymousAccessEnabled bool
    (Bool) Enable anonymous access
    AnonymousTokenExpiresIn float64
    (Number) The length of time for which an anonymous token is valid in seconds
    Id string
    IdTokenClaims []GetAppidTokenConfigIdTokenClaim
    (Set of Object) A set of objects that are created when claims that are related to identity tokens are mapped
    RefreshTokenEnabled bool
    (Bool) Enable refresh token
    RefreshTokenExpiresIn float64
    (Number) The length of time for which refresh tokens are valid in seconds
    TenantId string
    accessTokenClaims List<GetAppidTokenConfigAccessTokenClaim>
    (Set of Object) A set of objects that are created when claims that are related to access tokens are mapped
    accessTokenExpiresIn Double
    (Number) The length of time for which access tokens are valid in seconds
    anonymousAccessEnabled Boolean
    (Bool) Enable anonymous access
    anonymousTokenExpiresIn Double
    (Number) The length of time for which an anonymous token is valid in seconds
    id String
    idTokenClaims List<GetAppidTokenConfigIdTokenClaim>
    (Set of Object) A set of objects that are created when claims that are related to identity tokens are mapped
    refreshTokenEnabled Boolean
    (Bool) Enable refresh token
    refreshTokenExpiresIn Double
    (Number) The length of time for which refresh tokens are valid in seconds
    tenantId String
    accessTokenClaims GetAppidTokenConfigAccessTokenClaim[]
    (Set of Object) A set of objects that are created when claims that are related to access tokens are mapped
    accessTokenExpiresIn number
    (Number) The length of time for which access tokens are valid in seconds
    anonymousAccessEnabled boolean
    (Bool) Enable anonymous access
    anonymousTokenExpiresIn number
    (Number) The length of time for which an anonymous token is valid in seconds
    id string
    idTokenClaims GetAppidTokenConfigIdTokenClaim[]
    (Set of Object) A set of objects that are created when claims that are related to identity tokens are mapped
    refreshTokenEnabled boolean
    (Bool) Enable refresh token
    refreshTokenExpiresIn number
    (Number) The length of time for which refresh tokens are valid in seconds
    tenantId string
    access_token_claims Sequence[GetAppidTokenConfigAccessTokenClaim]
    (Set of Object) A set of objects that are created when claims that are related to access tokens are mapped
    access_token_expires_in float
    (Number) The length of time for which access tokens are valid in seconds
    anonymous_access_enabled bool
    (Bool) Enable anonymous access
    anonymous_token_expires_in float
    (Number) The length of time for which an anonymous token is valid in seconds
    id str
    id_token_claims Sequence[GetAppidTokenConfigIdTokenClaim]
    (Set of Object) A set of objects that are created when claims that are related to identity tokens are mapped
    refresh_token_enabled bool
    (Bool) Enable refresh token
    refresh_token_expires_in float
    (Number) The length of time for which refresh tokens are valid in seconds
    tenant_id str
    accessTokenClaims List<Property Map>
    (Set of Object) A set of objects that are created when claims that are related to access tokens are mapped
    accessTokenExpiresIn Number
    (Number) The length of time for which access tokens are valid in seconds
    anonymousAccessEnabled Boolean
    (Bool) Enable anonymous access
    anonymousTokenExpiresIn Number
    (Number) The length of time for which an anonymous token is valid in seconds
    id String
    idTokenClaims List<Property Map>
    (Set of Object) A set of objects that are created when claims that are related to identity tokens are mapped
    refreshTokenEnabled Boolean
    (Bool) Enable refresh token
    refreshTokenExpiresIn Number
    (Number) The length of time for which refresh tokens are valid in seconds
    tenantId String

    Supporting Types

    GetAppidTokenConfigAccessTokenClaim

    DestinationClaim string
    (String) Defines the custom attribute that can override the current claim in token
    Source string
    (String) Defines the source of the claim. Options include: saml, cloud_directory, facebook, google, appid_custom, and attributes
    SourceClaim string
    (String) Defines the claim as provided by the source. It can refer to the identity provider's user information or the user's App ID custom attributes
    DestinationClaim string
    (String) Defines the custom attribute that can override the current claim in token
    Source string
    (String) Defines the source of the claim. Options include: saml, cloud_directory, facebook, google, appid_custom, and attributes
    SourceClaim string
    (String) Defines the claim as provided by the source. It can refer to the identity provider's user information or the user's App ID custom attributes
    destinationClaim String
    (String) Defines the custom attribute that can override the current claim in token
    source String
    (String) Defines the source of the claim. Options include: saml, cloud_directory, facebook, google, appid_custom, and attributes
    sourceClaim String
    (String) Defines the claim as provided by the source. It can refer to the identity provider's user information or the user's App ID custom attributes
    destinationClaim string
    (String) Defines the custom attribute that can override the current claim in token
    source string
    (String) Defines the source of the claim. Options include: saml, cloud_directory, facebook, google, appid_custom, and attributes
    sourceClaim string
    (String) Defines the claim as provided by the source. It can refer to the identity provider's user information or the user's App ID custom attributes
    destination_claim str
    (String) Defines the custom attribute that can override the current claim in token
    source str
    (String) Defines the source of the claim. Options include: saml, cloud_directory, facebook, google, appid_custom, and attributes
    source_claim str
    (String) Defines the claim as provided by the source. It can refer to the identity provider's user information or the user's App ID custom attributes
    destinationClaim String
    (String) Defines the custom attribute that can override the current claim in token
    source String
    (String) Defines the source of the claim. Options include: saml, cloud_directory, facebook, google, appid_custom, and attributes
    sourceClaim String
    (String) Defines the claim as provided by the source. It can refer to the identity provider's user information or the user's App ID custom attributes

    GetAppidTokenConfigIdTokenClaim

    DestinationClaim string
    (String) Defines the custom attribute that can override the current claim in token
    Source string
    (String) Defines the source of the claim. Options include: saml, cloud_directory, facebook, google, appid_custom, and attributes
    SourceClaim string
    (String) Defines the claim as provided by the source. It can refer to the identity provider's user information or the user's App ID custom attributes
    DestinationClaim string
    (String) Defines the custom attribute that can override the current claim in token
    Source string
    (String) Defines the source of the claim. Options include: saml, cloud_directory, facebook, google, appid_custom, and attributes
    SourceClaim string
    (String) Defines the claim as provided by the source. It can refer to the identity provider's user information or the user's App ID custom attributes
    destinationClaim String
    (String) Defines the custom attribute that can override the current claim in token
    source String
    (String) Defines the source of the claim. Options include: saml, cloud_directory, facebook, google, appid_custom, and attributes
    sourceClaim String
    (String) Defines the claim as provided by the source. It can refer to the identity provider's user information or the user's App ID custom attributes
    destinationClaim string
    (String) Defines the custom attribute that can override the current claim in token
    source string
    (String) Defines the source of the claim. Options include: saml, cloud_directory, facebook, google, appid_custom, and attributes
    sourceClaim string
    (String) Defines the claim as provided by the source. It can refer to the identity provider's user information or the user's App ID custom attributes
    destination_claim str
    (String) Defines the custom attribute that can override the current claim in token
    source str
    (String) Defines the source of the claim. Options include: saml, cloud_directory, facebook, google, appid_custom, and attributes
    source_claim str
    (String) Defines the claim as provided by the source. It can refer to the identity provider's user information or the user's App ID custom attributes
    destinationClaim String
    (String) Defines the custom attribute that can override the current claim in token
    source String
    (String) Defines the source of the claim. Options include: saml, cloud_directory, facebook, google, appid_custom, and attributes
    sourceClaim String
    (String) Defines the claim as provided by the source. It can refer to the identity provider's user information or the user's App ID custom attributes

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud