1. Packages
  2. Okta
  3. API Docs
  4. getAuthServerClaims
Okta v4.7.0 published on Tuesday, Feb 13, 2024 by Pulumi

okta.getAuthServerClaims

Explore with Pulumi AI

okta logo
Okta v4.7.0 published on Tuesday, Feb 13, 2024 by Pulumi

    Use this data source to retrieve a list of authorization server claims from Okta.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var test = Okta.GetAuthServerClaims.Invoke(new()
        {
            AuthServerId = "default",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := okta.GetAuthServerClaims(ctx, &okta.GetAuthServerClaimsArgs{
    			AuthServerId: "default",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.OktaFunctions;
    import com.pulumi.okta.inputs.GetAuthServerClaimsArgs;
    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 test = OktaFunctions.getAuthServerClaims(GetAuthServerClaimsArgs.builder()
                .authServerId("default")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_okta as okta
    
    test = okta.get_auth_server_claims(auth_server_id="default")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const test = okta.getAuthServerClaims({
        authServerId: "default",
    });
    
    variables:
      test:
        fn::invoke:
          Function: okta:getAuthServerClaims
          Arguments:
            authServerId: default
    

    Using getAuthServerClaims

    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 getAuthServerClaims(args: GetAuthServerClaimsArgs, opts?: InvokeOptions): Promise<GetAuthServerClaimsResult>
    function getAuthServerClaimsOutput(args: GetAuthServerClaimsOutputArgs, opts?: InvokeOptions): Output<GetAuthServerClaimsResult>
    def get_auth_server_claims(auth_server_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetAuthServerClaimsResult
    def get_auth_server_claims_output(auth_server_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetAuthServerClaimsResult]
    func GetAuthServerClaims(ctx *Context, args *GetAuthServerClaimsArgs, opts ...InvokeOption) (*GetAuthServerClaimsResult, error)
    func GetAuthServerClaimsOutput(ctx *Context, args *GetAuthServerClaimsOutputArgs, opts ...InvokeOption) GetAuthServerClaimsResultOutput

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

    public static class GetAuthServerClaims 
    {
        public static Task<GetAuthServerClaimsResult> InvokeAsync(GetAuthServerClaimsArgs args, InvokeOptions? opts = null)
        public static Output<GetAuthServerClaimsResult> Invoke(GetAuthServerClaimsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAuthServerClaimsResult> getAuthServerClaims(GetAuthServerClaimsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: okta:index/getAuthServerClaims:getAuthServerClaims
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AuthServerId string
    Auth server ID.
    AuthServerId string
    Auth server ID.
    authServerId String
    Auth server ID.
    authServerId string
    Auth server ID.
    auth_server_id str
    Auth server ID.
    authServerId String
    Auth server ID.

    getAuthServerClaims Result

    The following output properties are available:

    AuthServerId string
    Claims List<GetAuthServerClaimsClaim>
    collection of authorization server claims retrieved from Okta with the following properties.
    Id string
    The provider-assigned unique ID for this managed resource.
    AuthServerId string
    Claims []GetAuthServerClaimsClaim
    collection of authorization server claims retrieved from Okta with the following properties.
    Id string
    The provider-assigned unique ID for this managed resource.
    authServerId String
    claims List<GetAuthServerClaimsClaim>
    collection of authorization server claims retrieved from Okta with the following properties.
    id String
    The provider-assigned unique ID for this managed resource.
    authServerId string
    claims GetAuthServerClaimsClaim[]
    collection of authorization server claims retrieved from Okta with the following properties.
    id string
    The provider-assigned unique ID for this managed resource.
    auth_server_id str
    claims Sequence[GetAuthServerClaimsClaim]
    collection of authorization server claims retrieved from Okta with the following properties.
    id str
    The provider-assigned unique ID for this managed resource.
    authServerId String
    claims List<Property Map>
    collection of authorization server claims retrieved from Okta with the following properties.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GetAuthServerClaimsClaim

    AlwaysIncludeInToken bool
    Specifies whether to include Claims in the token.
    ClaimType string
    Specifies whether the Claim is for an access token ("RESOURCE") or ID token ("IDENTITY").
    Id string
    ID of the claim.
    Name string
    Name of the claim.
    Scopes List<string>
    Specifies the scopes for this Claim.
    Status string
    Status of the claim.
    Value string
    Value of the claim
    ValueType string
    Specifies whether the Claim is an Okta EL expression ("EXPRESSION"), a set of groups ("GROUPS"), or a system claim ("SYSTEM")
    AlwaysIncludeInToken bool
    Specifies whether to include Claims in the token.
    ClaimType string
    Specifies whether the Claim is for an access token ("RESOURCE") or ID token ("IDENTITY").
    Id string
    ID of the claim.
    Name string
    Name of the claim.
    Scopes []string
    Specifies the scopes for this Claim.
    Status string
    Status of the claim.
    Value string
    Value of the claim
    ValueType string
    Specifies whether the Claim is an Okta EL expression ("EXPRESSION"), a set of groups ("GROUPS"), or a system claim ("SYSTEM")
    alwaysIncludeInToken Boolean
    Specifies whether to include Claims in the token.
    claimType String
    Specifies whether the Claim is for an access token ("RESOURCE") or ID token ("IDENTITY").
    id String
    ID of the claim.
    name String
    Name of the claim.
    scopes List<String>
    Specifies the scopes for this Claim.
    status String
    Status of the claim.
    value String
    Value of the claim
    valueType String
    Specifies whether the Claim is an Okta EL expression ("EXPRESSION"), a set of groups ("GROUPS"), or a system claim ("SYSTEM")
    alwaysIncludeInToken boolean
    Specifies whether to include Claims in the token.
    claimType string
    Specifies whether the Claim is for an access token ("RESOURCE") or ID token ("IDENTITY").
    id string
    ID of the claim.
    name string
    Name of the claim.
    scopes string[]
    Specifies the scopes for this Claim.
    status string
    Status of the claim.
    value string
    Value of the claim
    valueType string
    Specifies whether the Claim is an Okta EL expression ("EXPRESSION"), a set of groups ("GROUPS"), or a system claim ("SYSTEM")
    always_include_in_token bool
    Specifies whether to include Claims in the token.
    claim_type str
    Specifies whether the Claim is for an access token ("RESOURCE") or ID token ("IDENTITY").
    id str
    ID of the claim.
    name str
    Name of the claim.
    scopes Sequence[str]
    Specifies the scopes for this Claim.
    status str
    Status of the claim.
    value str
    Value of the claim
    value_type str
    Specifies whether the Claim is an Okta EL expression ("EXPRESSION"), a set of groups ("GROUPS"), or a system claim ("SYSTEM")
    alwaysIncludeInToken Boolean
    Specifies whether to include Claims in the token.
    claimType String
    Specifies whether the Claim is for an access token ("RESOURCE") or ID token ("IDENTITY").
    id String
    ID of the claim.
    name String
    Name of the claim.
    scopes List<String>
    Specifies the scopes for this Claim.
    status String
    Status of the claim.
    value String
    Value of the claim
    valueType String
    Specifies whether the Claim is an Okta EL expression ("EXPRESSION"), a set of groups ("GROUPS"), or a system claim ("SYSTEM")

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v4.7.0 published on Tuesday, Feb 13, 2024 by Pulumi