1. Packages
  2. Okta
  3. API Docs
  4. getAuthServerClaim
Okta v4.4.0 published on Monday, Sep 18, 2023 by Pulumi

okta.getAuthServerClaim

Explore with Pulumi AI

okta logo
Okta v4.4.0 published on Monday, Sep 18, 2023 by Pulumi

    Use this data source to retrieve authorization server claim from Okta.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var test = Okta.GetAuthServerClaim.Invoke(new()
        {
            AuthServerId = "default",
            Name = "birthdate",
        });
    
    });
    
    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.GetAuthServerClaim(ctx, &okta.GetAuthServerClaimArgs{
    			AuthServerId: "default",
    			Name:         pulumi.StringRef("birthdate"),
    		}, 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.GetAuthServerClaimArgs;
    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.getAuthServerClaim(GetAuthServerClaimArgs.builder()
                .authServerId("default")
                .name("birthdate")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_okta as okta
    
    test = okta.get_auth_server_claim(auth_server_id="default",
        name="birthdate")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const test = okta.getAuthServerClaim({
        authServerId: "default",
        name: "birthdate",
    });
    
    variables:
      test:
        fn::invoke:
          Function: okta:getAuthServerClaim
          Arguments:
            authServerId: default
            name: birthdate
    

    Using getAuthServerClaim

    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 getAuthServerClaim(args: GetAuthServerClaimArgs, opts?: InvokeOptions): Promise<GetAuthServerClaimResult>
    function getAuthServerClaimOutput(args: GetAuthServerClaimOutputArgs, opts?: InvokeOptions): Output<GetAuthServerClaimResult>
    def get_auth_server_claim(auth_server_id: Optional[str] = None,
                              id: Optional[str] = None,
                              name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetAuthServerClaimResult
    def get_auth_server_claim_output(auth_server_id: Optional[pulumi.Input[str]] = None,
                              id: Optional[pulumi.Input[str]] = None,
                              name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetAuthServerClaimResult]
    func GetAuthServerClaim(ctx *Context, args *GetAuthServerClaimArgs, opts ...InvokeOption) (*GetAuthServerClaimResult, error)
    func GetAuthServerClaimOutput(ctx *Context, args *GetAuthServerClaimOutputArgs, opts ...InvokeOption) GetAuthServerClaimResultOutput

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

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

    The following arguments are supported:

    AuthServerId string

    Auth server ID.

    Id string

    ID of the claim. Conflicts with name.

    Name string

    Name of the claim. Conflicts with id.

    AuthServerId string

    Auth server ID.

    Id string

    ID of the claim. Conflicts with name.

    Name string

    Name of the claim. Conflicts with id.

    authServerId String

    Auth server ID.

    id String

    ID of the claim. Conflicts with name.

    name String

    Name of the claim. Conflicts with id.

    authServerId string

    Auth server ID.

    id string

    ID of the claim. Conflicts with name.

    name string

    Name of the claim. Conflicts with id.

    auth_server_id str

    Auth server ID.

    id str

    ID of the claim. Conflicts with name.

    name str

    Name of the claim. Conflicts with id.

    authServerId String

    Auth server ID.

    id String

    ID of the claim. Conflicts with name.

    name String

    Name of the claim. Conflicts with id.

    getAuthServerClaim Result

    The following output properties are available:

    AlwaysIncludeInToken bool

    Specifies whether to include Claims in the token.

    AuthServerId string
    ClaimType string

    Specifies whether the Claim is for an access token ("RESOURCE") or ID token ("IDENTITY").

    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")

    Id string

    ID of the claim.

    Name string

    Name of the claim.

    AlwaysIncludeInToken bool

    Specifies whether to include Claims in the token.

    AuthServerId string
    ClaimType string

    Specifies whether the Claim is for an access token ("RESOURCE") or ID token ("IDENTITY").

    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")

    Id string

    ID of the claim.

    Name string

    Name of the claim.

    alwaysIncludeInToken Boolean

    Specifies whether to include Claims in the token.

    authServerId String
    claimType String

    Specifies whether the Claim is for an access token ("RESOURCE") or ID token ("IDENTITY").

    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")

    id String

    ID of the claim.

    name String

    Name of the claim.

    alwaysIncludeInToken boolean

    Specifies whether to include Claims in the token.

    authServerId string
    claimType string

    Specifies whether the Claim is for an access token ("RESOURCE") or ID token ("IDENTITY").

    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")

    id string

    ID of the claim.

    name string

    Name of the claim.

    always_include_in_token bool

    Specifies whether to include Claims in the token.

    auth_server_id str
    claim_type str

    Specifies whether the Claim is for an access token ("RESOURCE") or ID token ("IDENTITY").

    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")

    id str

    ID of the claim.

    name str

    Name of the claim.

    alwaysIncludeInToken Boolean

    Specifies whether to include Claims in the token.

    authServerId String
    claimType String

    Specifies whether the Claim is for an access token ("RESOURCE") or ID token ("IDENTITY").

    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")

    id String

    ID of the claim.

    name String

    Name of the claim.

    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.4.0 published on Monday, Sep 18, 2023 by Pulumi