1. Packages
  2. Packages
  3. Konnect Provider
  4. API Docs
  5. IdentityAuthServerClaim
Viewing docs for konnect 3.14.0
published on Friday, Apr 24, 2026 by kong
Schema (JSON)
kong/terraform-provider-konnect

konnect.IdentityAuthServerClaim

Viewing docs for konnect 3.14.0
published on Friday, Apr 24, 2026 by kong
Schema (JSON)
kong/terraform-provider-konnect

    IdentityAuthServerClaim Resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as konnect from "@pulumi/konnect";

const myIdentityauthserverclaim = new konnect.IdentityAuthServerClaim("my_identityauthserverclaim", {
    authServerId: "d32d905a-ed33-46a3-a093-d8f536af9a8a",
    enabled: true,
    includeInAllScopes: false,
    includeInScopes: ["e9ba539f-d8df-46a2-bb67-ebcfb3a66f38"],
    includeInToken: false,
    name: "...my_name...",
    value: "...my_value...",
});

    import pulumi
import pulumi_konnect as konnect

my_identityauthserverclaim = konnect.IdentityAuthServerClaim("my_identityauthserverclaim",
    auth_server_id="d32d905a-ed33-46a3-a093-d8f536af9a8a",
    enabled=True,
    include_in_all_scopes=False,
    include_in_scopes=["e9ba539f-d8df-46a2-bb67-ebcfb3a66f38"],
    include_in_token=False,
    name="...my_name...",
    value="...my_value...")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/konnect/v3/konnect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := konnect.NewIdentityAuthServerClaim(ctx, "my_identityauthserverclaim", &konnect.IdentityAuthServerClaimArgs{
			AuthServerId:       pulumi.String("d32d905a-ed33-46a3-a093-d8f536af9a8a"),
			Enabled:            pulumi.Bool(true),
			IncludeInAllScopes: pulumi.Bool(false),
			IncludeInScopes: pulumi.StringArray{
				pulumi.String("e9ba539f-d8df-46a2-bb67-ebcfb3a66f38"),
			},
			IncludeInToken: pulumi.Bool(false),
			Name:           pulumi.String("...my_name..."),
			Value:          pulumi.String("...my_value..."),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Konnect = Pulumi.Konnect;

return await Deployment.RunAsync(() => 
{
    var myIdentityauthserverclaim = new Konnect.IdentityAuthServerClaim("my_identityauthserverclaim", new()
    {
        AuthServerId = "d32d905a-ed33-46a3-a093-d8f536af9a8a",
        Enabled = true,
        IncludeInAllScopes = false,
        IncludeInScopes = new[]
        {
            "e9ba539f-d8df-46a2-bb67-ebcfb3a66f38",
        },
        IncludeInToken = false,
        Name = "...my_name...",
        Value = "...my_value...",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.IdentityAuthServerClaim;
import com.pulumi.konnect.IdentityAuthServerClaimArgs;
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) {
        var myIdentityauthserverclaim = new IdentityAuthServerClaim("myIdentityauthserverclaim", IdentityAuthServerClaimArgs.builder()
            .authServerId("d32d905a-ed33-46a3-a093-d8f536af9a8a")
            .enabled(true)
            .includeInAllScopes(false)
            .includeInScopes("e9ba539f-d8df-46a2-bb67-ebcfb3a66f38")
            .includeInToken(false)
            .name("...my_name...")
            .value("...my_value...")
            .build());

    }
}

    resources:
  myIdentityauthserverclaim:
    type: konnect:IdentityAuthServerClaim
    name: my_identityauthserverclaim
    properties:
      authServerId: d32d905a-ed33-46a3-a093-d8f536af9a8a
      enabled: true
      includeInAllScopes: false
      includeInScopes:
        - e9ba539f-d8df-46a2-bb67-ebcfb3a66f38
      includeInToken: false
      name: '...my_name...'
      value: '...my_value...'

    Create IdentityAuthServerClaim Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IdentityAuthServerClaim(name: string, args: IdentityAuthServerClaimArgs, opts?: CustomResourceOptions);
    @overload
def IdentityAuthServerClaim(resource_name: str,
                            args: IdentityAuthServerClaimArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def IdentityAuthServerClaim(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            auth_server_id: Optional[str] = None,
                            value: Optional[str] = None,
                            enabled: Optional[bool] = None,
                            include_in_all_scopes: Optional[bool] = None,
                            include_in_scopes: Optional[Sequence[str]] = None,
                            include_in_token: Optional[bool] = None,
                            name: Optional[str] = None)
    func NewIdentityAuthServerClaim(ctx *Context, name string, args IdentityAuthServerClaimArgs, opts ...ResourceOption) (*IdentityAuthServerClaim, error)
    public IdentityAuthServerClaim(string name, IdentityAuthServerClaimArgs args, CustomResourceOptions? opts = null)
    public IdentityAuthServerClaim(String name, IdentityAuthServerClaimArgs args)
public IdentityAuthServerClaim(String name, IdentityAuthServerClaimArgs args, CustomResourceOptions options)

    type: konnect:IdentityAuthServerClaim
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args IdentityAuthServerClaimArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IdentityAuthServerClaimArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IdentityAuthServerClaimArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IdentityAuthServerClaimArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IdentityAuthServerClaimArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var identityAuthServerClaimResource = new Konnect.IdentityAuthServerClaim("identityAuthServerClaimResource", new()
{
    AuthServerId = "string",
    Value = "string",
    Enabled = false,
    IncludeInAllScopes = false,
    IncludeInScopes = new[]
    {
        "string",
    },
    IncludeInToken = false,
    Name = "string",
});

    example, err := konnect.NewIdentityAuthServerClaim(ctx, "identityAuthServerClaimResource", &konnect.IdentityAuthServerClaimArgs{
	AuthServerId:       pulumi.String("string"),
	Value:              pulumi.String("string"),
	Enabled:            pulumi.Bool(false),
	IncludeInAllScopes: pulumi.Bool(false),
	IncludeInScopes: pulumi.StringArray{
		pulumi.String("string"),
	},
	IncludeInToken: pulumi.Bool(false),
	Name:           pulumi.String("string"),
})

    var identityAuthServerClaimResource = new IdentityAuthServerClaim("identityAuthServerClaimResource", IdentityAuthServerClaimArgs.builder()
    .authServerId("string")
    .value("string")
    .enabled(false)
    .includeInAllScopes(false)
    .includeInScopes("string")
    .includeInToken(false)
    .name("string")
    .build());

    identity_auth_server_claim_resource = konnect.IdentityAuthServerClaim("identityAuthServerClaimResource",
    auth_server_id="string",
    value="string",
    enabled=False,
    include_in_all_scopes=False,
    include_in_scopes=["string"],
    include_in_token=False,
    name="string")

    const identityAuthServerClaimResource = new konnect.IdentityAuthServerClaim("identityAuthServerClaimResource", {
    authServerId: "string",
    value: "string",
    enabled: false,
    includeInAllScopes: false,
    includeInScopes: ["string"],
    includeInToken: false,
    name: "string",
});

    type: konnect:IdentityAuthServerClaim
properties:
    authServerId: string
    enabled: false
    includeInAllScopes: false
    includeInScopes:
        - string
    includeInToken: false
    name: string
    value: string

    IdentityAuthServerClaim Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The IdentityAuthServerClaim resource accepts the following input properties:

    AuthServerId string
    The auth server ID
    Value string
    Specifies the value of the claim. It may contain a static value or a dynamic (templated) value. Static values which are valid JSON will result in a JSON object in the token claims.
    Enabled bool
    Specifies whether the claim is enabled. If the claim is not enabled, it will not be included in the token or the '/userinfo' endpoint. Default: true
    IncludeInAllScopes bool
    Specifies whether to include the claim in all scopes. If the value is set to 'false' for a claim, the claim is only included in the scopes that explicitly list it. Default: false
    IncludeInScopes List<string>
    Specifies the scopes IDs in which the claim is included
    IncludeInToken bool
    Specifies whether to include claim in the token. If the value is set to 'false' for a claim, the client instead uses the access token to get claims from the '/userinfo' endpoint. Default: false
    Name string
    The name of the claim
    AuthServerId string
    The auth server ID
    Value string
    Specifies the value of the claim. It may contain a static value or a dynamic (templated) value. Static values which are valid JSON will result in a JSON object in the token claims.
    Enabled bool
    Specifies whether the claim is enabled. If the claim is not enabled, it will not be included in the token or the '/userinfo' endpoint. Default: true
    IncludeInAllScopes bool
    Specifies whether to include the claim in all scopes. If the value is set to 'false' for a claim, the claim is only included in the scopes that explicitly list it. Default: false
    IncludeInScopes []string
    Specifies the scopes IDs in which the claim is included
    IncludeInToken bool
    Specifies whether to include claim in the token. If the value is set to 'false' for a claim, the client instead uses the access token to get claims from the '/userinfo' endpoint. Default: false
    Name string
    The name of the claim
    authServerId String
    The auth server ID
    value String
    Specifies the value of the claim. It may contain a static value or a dynamic (templated) value. Static values which are valid JSON will result in a JSON object in the token claims.
    enabled Boolean
    Specifies whether the claim is enabled. If the claim is not enabled, it will not be included in the token or the '/userinfo' endpoint. Default: true
    includeInAllScopes Boolean
    Specifies whether to include the claim in all scopes. If the value is set to 'false' for a claim, the claim is only included in the scopes that explicitly list it. Default: false
    includeInScopes List<String>
    Specifies the scopes IDs in which the claim is included
    includeInToken Boolean
    Specifies whether to include claim in the token. If the value is set to 'false' for a claim, the client instead uses the access token to get claims from the '/userinfo' endpoint. Default: false
    name String
    The name of the claim
    authServerId string
    The auth server ID
    value string
    Specifies the value of the claim. It may contain a static value or a dynamic (templated) value. Static values which are valid JSON will result in a JSON object in the token claims.
    enabled boolean
    Specifies whether the claim is enabled. If the claim is not enabled, it will not be included in the token or the '/userinfo' endpoint. Default: true
    includeInAllScopes boolean
    Specifies whether to include the claim in all scopes. If the value is set to 'false' for a claim, the claim is only included in the scopes that explicitly list it. Default: false
    includeInScopes string[]
    Specifies the scopes IDs in which the claim is included
    includeInToken boolean
    Specifies whether to include claim in the token. If the value is set to 'false' for a claim, the client instead uses the access token to get claims from the '/userinfo' endpoint. Default: false
    name string
    The name of the claim
    auth_server_id str
    The auth server ID
    value str
    Specifies the value of the claim. It may contain a static value or a dynamic (templated) value. Static values which are valid JSON will result in a JSON object in the token claims.
    enabled bool
    Specifies whether the claim is enabled. If the claim is not enabled, it will not be included in the token or the '/userinfo' endpoint. Default: true
    include_in_all_scopes bool
    Specifies whether to include the claim in all scopes. If the value is set to 'false' for a claim, the claim is only included in the scopes that explicitly list it. Default: false
    include_in_scopes Sequence[str]
    Specifies the scopes IDs in which the claim is included
    include_in_token bool
    Specifies whether to include claim in the token. If the value is set to 'false' for a claim, the client instead uses the access token to get claims from the '/userinfo' endpoint. Default: false
    name str
    The name of the claim
    authServerId String
    The auth server ID
    value String
    Specifies the value of the claim. It may contain a static value or a dynamic (templated) value. Static values which are valid JSON will result in a JSON object in the token claims.
    enabled Boolean
    Specifies whether the claim is enabled. If the claim is not enabled, it will not be included in the token or the '/userinfo' endpoint. Default: true
    includeInAllScopes Boolean
    Specifies whether to include the claim in all scopes. If the value is set to 'false' for a claim, the claim is only included in the scopes that explicitly list it. Default: false
    includeInScopes List<String>
    Specifies the scopes IDs in which the claim is included
    includeInToken Boolean
    Specifies whether to include claim in the token. If the value is set to 'false' for a claim, the client instead uses the access token to get claims from the '/userinfo' endpoint. Default: false
    name String
    The name of the claim

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IdentityAuthServerClaim resource produces the following output properties:

    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Look up Existing IdentityAuthServerClaim Resource

    Get an existing IdentityAuthServerClaim resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: IdentityAuthServerClaimState, opts?: CustomResourceOptions): IdentityAuthServerClaim
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_server_id: Optional[str] = None,
        created_at: Optional[str] = None,
        enabled: Optional[bool] = None,
        include_in_all_scopes: Optional[bool] = None,
        include_in_scopes: Optional[Sequence[str]] = None,
        include_in_token: Optional[bool] = None,
        name: Optional[str] = None,
        updated_at: Optional[str] = None,
        value: Optional[str] = None) -> IdentityAuthServerClaim
    func GetIdentityAuthServerClaim(ctx *Context, name string, id IDInput, state *IdentityAuthServerClaimState, opts ...ResourceOption) (*IdentityAuthServerClaim, error)
    public static IdentityAuthServerClaim Get(string name, Input<string> id, IdentityAuthServerClaimState? state, CustomResourceOptions? opts = null)
    public static IdentityAuthServerClaim get(String name, Output<String> id, IdentityAuthServerClaimState state, CustomResourceOptions options)
    resources:  _:    type: konnect:IdentityAuthServerClaim    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AuthServerId string
    The auth server ID
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Enabled bool
    Specifies whether the claim is enabled. If the claim is not enabled, it will not be included in the token or the '/userinfo' endpoint. Default: true
    IncludeInAllScopes bool
    Specifies whether to include the claim in all scopes. If the value is set to 'false' for a claim, the claim is only included in the scopes that explicitly list it. Default: false
    IncludeInScopes List<string>
    Specifies the scopes IDs in which the claim is included
    IncludeInToken bool
    Specifies whether to include claim in the token. If the value is set to 'false' for a claim, the client instead uses the access token to get claims from the '/userinfo' endpoint. Default: false
    Name string
    The name of the claim
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    Value string
    Specifies the value of the claim. It may contain a static value or a dynamic (templated) value. Static values which are valid JSON will result in a JSON object in the token claims.
    AuthServerId string
    The auth server ID
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Enabled bool
    Specifies whether the claim is enabled. If the claim is not enabled, it will not be included in the token or the '/userinfo' endpoint. Default: true
    IncludeInAllScopes bool
    Specifies whether to include the claim in all scopes. If the value is set to 'false' for a claim, the claim is only included in the scopes that explicitly list it. Default: false
    IncludeInScopes []string
    Specifies the scopes IDs in which the claim is included
    IncludeInToken bool
    Specifies whether to include claim in the token. If the value is set to 'false' for a claim, the client instead uses the access token to get claims from the '/userinfo' endpoint. Default: false
    Name string
    The name of the claim
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    Value string
    Specifies the value of the claim. It may contain a static value or a dynamic (templated) value. Static values which are valid JSON will result in a JSON object in the token claims.
    authServerId String
    The auth server ID
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    enabled Boolean
    Specifies whether the claim is enabled. If the claim is not enabled, it will not be included in the token or the '/userinfo' endpoint. Default: true
    includeInAllScopes Boolean
    Specifies whether to include the claim in all scopes. If the value is set to 'false' for a claim, the claim is only included in the scopes that explicitly list it. Default: false
    includeInScopes List<String>
    Specifies the scopes IDs in which the claim is included
    includeInToken Boolean
    Specifies whether to include claim in the token. If the value is set to 'false' for a claim, the client instead uses the access token to get claims from the '/userinfo' endpoint. Default: false
    name String
    The name of the claim
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    value String
    Specifies the value of the claim. It may contain a static value or a dynamic (templated) value. Static values which are valid JSON will result in a JSON object in the token claims.
    authServerId string
    The auth server ID
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    enabled boolean
    Specifies whether the claim is enabled. If the claim is not enabled, it will not be included in the token or the '/userinfo' endpoint. Default: true
    includeInAllScopes boolean
    Specifies whether to include the claim in all scopes. If the value is set to 'false' for a claim, the claim is only included in the scopes that explicitly list it. Default: false
    includeInScopes string[]
    Specifies the scopes IDs in which the claim is included
    includeInToken boolean
    Specifies whether to include claim in the token. If the value is set to 'false' for a claim, the client instead uses the access token to get claims from the '/userinfo' endpoint. Default: false
    name string
    The name of the claim
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    value string
    Specifies the value of the claim. It may contain a static value or a dynamic (templated) value. Static values which are valid JSON will result in a JSON object in the token claims.
    auth_server_id str
    The auth server ID
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    enabled bool
    Specifies whether the claim is enabled. If the claim is not enabled, it will not be included in the token or the '/userinfo' endpoint. Default: true
    include_in_all_scopes bool
    Specifies whether to include the claim in all scopes. If the value is set to 'false' for a claim, the claim is only included in the scopes that explicitly list it. Default: false
    include_in_scopes Sequence[str]
    Specifies the scopes IDs in which the claim is included
    include_in_token bool
    Specifies whether to include claim in the token. If the value is set to 'false' for a claim, the client instead uses the access token to get claims from the '/userinfo' endpoint. Default: false
    name str
    The name of the claim
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    value str
    Specifies the value of the claim. It may contain a static value or a dynamic (templated) value. Static values which are valid JSON will result in a JSON object in the token claims.
    authServerId String
    The auth server ID
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    enabled Boolean
    Specifies whether the claim is enabled. If the claim is not enabled, it will not be included in the token or the '/userinfo' endpoint. Default: true
    includeInAllScopes Boolean
    Specifies whether to include the claim in all scopes. If the value is set to 'false' for a claim, the claim is only included in the scopes that explicitly list it. Default: false
    includeInScopes List<String>
    Specifies the scopes IDs in which the claim is included
    includeInToken Boolean
    Specifies whether to include claim in the token. If the value is set to 'false' for a claim, the client instead uses the access token to get claims from the '/userinfo' endpoint. Default: false
    name String
    The name of the claim
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    value String
    Specifies the value of the claim. It may contain a static value or a dynamic (templated) value. Static values which are valid JSON will result in a JSON object in the token claims.

    Import

    In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

    terraform

    import {

    to = konnect_identity_auth_server_claim.my_konnect_identity_auth_server_claim

    id = jsonencode({

    auth_server_id = "d32d905a-ed33-46a3-a093-d8f536af9a8a"

id             = "07d05309-45cc-4b37-92fb-1524846deec3"

    })

    }

    The pulumi import command can be used, for example:

    $ pulumi import konnect:index/identityAuthServerClaim:IdentityAuthServerClaim my_konnect_identity_auth_server_claim '{"auth_server_id": "d32d905a-ed33-46a3-a093-d8f536af9a8a", "id": "07d05309-45cc-4b37-92fb-1524846deec3"}'

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    konnect kong/terraform-provider-konnect
    License
    Notes
    This Pulumi package is based on the konnect Terraform Provider.
    Viewing docs for konnect 3.14.0
    published on Friday, Apr 24, 2026 by kong
    Schema (JSON)
    kong/terraform-provider-konnect
      Try Pulumi Cloud free. Your team will thank you.