Okta

Pulumi Official
Package maintained by Pulumi
v3.9.0 published on Monday, May 16, 2022 by Pulumi

getAuthServerClaims

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

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
    public MyStack()
    {
        var test = Output.Create(Okta.GetAuthServerClaims.InvokeAsync(new Okta.GetAuthServerClaimsArgs
        {
            AuthServerId = "default",
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-okta/sdk/v3/go/okta"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.GetAuthServerClaims(ctx, &GetAuthServerClaimsArgs{
			AuthServerId: "default",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var test = Output.of(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 = pulumi.output(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 ListAuthServerClaimsClaim>

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

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

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

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
https://github.com/pulumi/pulumi-okta
License
Apache-2.0
Notes

This Pulumi package is based on the okta Terraform Provider.