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

konnect.IdentityAuthServerScope

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

    IdentityAuthServerScope Resource

    Example Usage

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

const myIdentityauthserverscope = new konnect.IdentityAuthServerScope("my_identityauthserverscope", {
    authServerId: "d32d905a-ed33-46a3-a093-d8f536af9a8a",
    "default": false,
    description: "...my_description...",
    enabled: true,
    includeInMetadata: false,
    name: "...my_name...",
});

    import pulumi
import pulumi_konnect as konnect

my_identityauthserverscope = konnect.IdentityAuthServerScope("my_identityauthserverscope",
    auth_server_id="d32d905a-ed33-46a3-a093-d8f536af9a8a",
    default=False,
    description="...my_description...",
    enabled=True,
    include_in_metadata=False,
    name="...my_name...")

    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.NewIdentityAuthServerScope(ctx, "my_identityauthserverscope", &konnect.IdentityAuthServerScopeArgs{
			AuthServerId:      pulumi.String("d32d905a-ed33-46a3-a093-d8f536af9a8a"),
			Default:           pulumi.Bool(false),
			Description:       pulumi.String("...my_description..."),
			Enabled:           pulumi.Bool(true),
			IncludeInMetadata: pulumi.Bool(false),
			Name:              pulumi.String("...my_name..."),
		})
		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 myIdentityauthserverscope = new Konnect.IdentityAuthServerScope("my_identityauthserverscope", new()
    {
        AuthServerId = "d32d905a-ed33-46a3-a093-d8f536af9a8a",
        Default = false,
        Description = "...my_description...",
        Enabled = true,
        IncludeInMetadata = false,
        Name = "...my_name...",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.IdentityAuthServerScope;
import com.pulumi.konnect.IdentityAuthServerScopeArgs;
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 myIdentityauthserverscope = new IdentityAuthServerScope("myIdentityauthserverscope", IdentityAuthServerScopeArgs.builder()
            .authServerId("d32d905a-ed33-46a3-a093-d8f536af9a8a")
            .default_(false)
            .description("...my_description...")
            .enabled(true)
            .includeInMetadata(false)
            .name("...my_name...")
            .build());

    }
}

    resources:
  myIdentityauthserverscope:
    type: konnect:IdentityAuthServerScope
    name: my_identityauthserverscope
    properties:
      authServerId: d32d905a-ed33-46a3-a093-d8f536af9a8a
      default: false
      description: '...my_description...'
      enabled: true
      includeInMetadata: false
      name: '...my_name...'

    Create IdentityAuthServerScope Resource

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

    Constructor syntax

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

@overload
def IdentityAuthServerScope(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            auth_server_id: Optional[str] = None,
                            default: Optional[bool] = None,
                            description: Optional[str] = None,
                            enabled: Optional[bool] = None,
                            include_in_metadata: Optional[bool] = None,
                            name: Optional[str] = None)
    func NewIdentityAuthServerScope(ctx *Context, name string, args IdentityAuthServerScopeArgs, opts ...ResourceOption) (*IdentityAuthServerScope, error)
    public IdentityAuthServerScope(string name, IdentityAuthServerScopeArgs args, CustomResourceOptions? opts = null)
    public IdentityAuthServerScope(String name, IdentityAuthServerScopeArgs args)
public IdentityAuthServerScope(String name, IdentityAuthServerScopeArgs args, CustomResourceOptions options)

    type: konnect:IdentityAuthServerScope
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 IdentityAuthServerScopeArgs
    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 IdentityAuthServerScopeArgs
    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 IdentityAuthServerScopeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IdentityAuthServerScopeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IdentityAuthServerScopeArgs
    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 identityAuthServerScopeResource = new Konnect.IdentityAuthServerScope("identityAuthServerScopeResource", new()
{
    AuthServerId = "string",
    Default = false,
    Description = "string",
    Enabled = false,
    IncludeInMetadata = false,
    Name = "string",
});

    example, err := konnect.NewIdentityAuthServerScope(ctx, "identityAuthServerScopeResource", &konnect.IdentityAuthServerScopeArgs{
	AuthServerId:      pulumi.String("string"),
	Default:           pulumi.Bool(false),
	Description:       pulumi.String("string"),
	Enabled:           pulumi.Bool(false),
	IncludeInMetadata: pulumi.Bool(false),
	Name:              pulumi.String("string"),
})

    var identityAuthServerScopeResource = new IdentityAuthServerScope("identityAuthServerScopeResource", IdentityAuthServerScopeArgs.builder()
    .authServerId("string")
    .default_(false)
    .description("string")
    .enabled(false)
    .includeInMetadata(false)
    .name("string")
    .build());

    identity_auth_server_scope_resource = konnect.IdentityAuthServerScope("identityAuthServerScopeResource",
    auth_server_id="string",
    default=False,
    description="string",
    enabled=False,
    include_in_metadata=False,
    name="string")

    const identityAuthServerScopeResource = new konnect.IdentityAuthServerScope("identityAuthServerScopeResource", {
    authServerId: "string",
    "default": false,
    description: "string",
    enabled: false,
    includeInMetadata: false,
    name: "string",
});

    type: konnect:IdentityAuthServerScope
properties:
    authServerId: string
    default: false
    description: string
    enabled: false
    includeInMetadata: false
    name: string

    IdentityAuthServerScope 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 IdentityAuthServerScope resource accepts the following input properties:

    AuthServerId string
    The auth server ID
    Default bool
    Specifies whether the scope is included by default in access tokens without being explicitly requested by the client. If the scope is not allowed by the client, it will not be included in the access token. Default: false
    Description string
    Description of the scope
    Enabled bool
    Specifies whether the scope is enabled. If the scope is not enabled, it cannot be requested by clients and will not be included in the access token. Default: true
    IncludeInMetadata bool
    Specifies whether to include the scope in the metadata document. Default: false
    Name string
    The name of the scope
    AuthServerId string
    The auth server ID
    Default bool
    Specifies whether the scope is included by default in access tokens without being explicitly requested by the client. If the scope is not allowed by the client, it will not be included in the access token. Default: false
    Description string
    Description of the scope
    Enabled bool
    Specifies whether the scope is enabled. If the scope is not enabled, it cannot be requested by clients and will not be included in the access token. Default: true
    IncludeInMetadata bool
    Specifies whether to include the scope in the metadata document. Default: false
    Name string
    The name of the scope
    authServerId String
    The auth server ID
    default_ Boolean
    Specifies whether the scope is included by default in access tokens without being explicitly requested by the client. If the scope is not allowed by the client, it will not be included in the access token. Default: false
    description String
    Description of the scope
    enabled Boolean
    Specifies whether the scope is enabled. If the scope is not enabled, it cannot be requested by clients and will not be included in the access token. Default: true
    includeInMetadata Boolean
    Specifies whether to include the scope in the metadata document. Default: false
    name String
    The name of the scope
    authServerId string
    The auth server ID
    default boolean
    Specifies whether the scope is included by default in access tokens without being explicitly requested by the client. If the scope is not allowed by the client, it will not be included in the access token. Default: false
    description string
    Description of the scope
    enabled boolean
    Specifies whether the scope is enabled. If the scope is not enabled, it cannot be requested by clients and will not be included in the access token. Default: true
    includeInMetadata boolean
    Specifies whether to include the scope in the metadata document. Default: false
    name string
    The name of the scope
    auth_server_id str
    The auth server ID
    default bool
    Specifies whether the scope is included by default in access tokens without being explicitly requested by the client. If the scope is not allowed by the client, it will not be included in the access token. Default: false
    description str
    Description of the scope
    enabled bool
    Specifies whether the scope is enabled. If the scope is not enabled, it cannot be requested by clients and will not be included in the access token. Default: true
    include_in_metadata bool
    Specifies whether to include the scope in the metadata document. Default: false
    name str
    The name of the scope
    authServerId String
    The auth server ID
    default Boolean
    Specifies whether the scope is included by default in access tokens without being explicitly requested by the client. If the scope is not allowed by the client, it will not be included in the access token. Default: false
    description String
    Description of the scope
    enabled Boolean
    Specifies whether the scope is enabled. If the scope is not enabled, it cannot be requested by clients and will not be included in the access token. Default: true
    includeInMetadata Boolean
    Specifies whether to include the scope in the metadata document. Default: false
    name String
    The name of the scope

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IdentityAuthServerScope 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 IdentityAuthServerScope Resource

    Get an existing IdentityAuthServerScope 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?: IdentityAuthServerScopeState, opts?: CustomResourceOptions): IdentityAuthServerScope
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_server_id: Optional[str] = None,
        created_at: Optional[str] = None,
        default: Optional[bool] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        include_in_metadata: Optional[bool] = None,
        name: Optional[str] = None,
        updated_at: Optional[str] = None) -> IdentityAuthServerScope
    func GetIdentityAuthServerScope(ctx *Context, name string, id IDInput, state *IdentityAuthServerScopeState, opts ...ResourceOption) (*IdentityAuthServerScope, error)
    public static IdentityAuthServerScope Get(string name, Input<string> id, IdentityAuthServerScopeState? state, CustomResourceOptions? opts = null)
    public static IdentityAuthServerScope get(String name, Output<String> id, IdentityAuthServerScopeState state, CustomResourceOptions options)
    resources:  _:    type: konnect:IdentityAuthServerScope    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.
    Default bool
    Specifies whether the scope is included by default in access tokens without being explicitly requested by the client. If the scope is not allowed by the client, it will not be included in the access token. Default: false
    Description string
    Description of the scope
    Enabled bool
    Specifies whether the scope is enabled. If the scope is not enabled, it cannot be requested by clients and will not be included in the access token. Default: true
    IncludeInMetadata bool
    Specifies whether to include the scope in the metadata document. Default: false
    Name string
    The name of the scope
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    AuthServerId string
    The auth server ID
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Default bool
    Specifies whether the scope is included by default in access tokens without being explicitly requested by the client. If the scope is not allowed by the client, it will not be included in the access token. Default: false
    Description string
    Description of the scope
    Enabled bool
    Specifies whether the scope is enabled. If the scope is not enabled, it cannot be requested by clients and will not be included in the access token. Default: true
    IncludeInMetadata bool
    Specifies whether to include the scope in the metadata document. Default: false
    Name string
    The name of the scope
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    authServerId String
    The auth server ID
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    default_ Boolean
    Specifies whether the scope is included by default in access tokens without being explicitly requested by the client. If the scope is not allowed by the client, it will not be included in the access token. Default: false
    description String
    Description of the scope
    enabled Boolean
    Specifies whether the scope is enabled. If the scope is not enabled, it cannot be requested by clients and will not be included in the access token. Default: true
    includeInMetadata Boolean
    Specifies whether to include the scope in the metadata document. Default: false
    name String
    The name of the scope
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    authServerId string
    The auth server ID
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    default boolean
    Specifies whether the scope is included by default in access tokens without being explicitly requested by the client. If the scope is not allowed by the client, it will not be included in the access token. Default: false
    description string
    Description of the scope
    enabled boolean
    Specifies whether the scope is enabled. If the scope is not enabled, it cannot be requested by clients and will not be included in the access token. Default: true
    includeInMetadata boolean
    Specifies whether to include the scope in the metadata document. Default: false
    name string
    The name of the scope
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    auth_server_id str
    The auth server ID
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    default bool
    Specifies whether the scope is included by default in access tokens without being explicitly requested by the client. If the scope is not allowed by the client, it will not be included in the access token. Default: false
    description str
    Description of the scope
    enabled bool
    Specifies whether the scope is enabled. If the scope is not enabled, it cannot be requested by clients and will not be included in the access token. Default: true
    include_in_metadata bool
    Specifies whether to include the scope in the metadata document. Default: false
    name str
    The name of the scope
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    authServerId String
    The auth server ID
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    default Boolean
    Specifies whether the scope is included by default in access tokens without being explicitly requested by the client. If the scope is not allowed by the client, it will not be included in the access token. Default: false
    description String
    Description of the scope
    enabled Boolean
    Specifies whether the scope is enabled. If the scope is not enabled, it cannot be requested by clients and will not be included in the access token. Default: true
    includeInMetadata Boolean
    Specifies whether to include the scope in the metadata document. Default: false
    name String
    The name of the scope
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    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_scope.my_konnect_identity_auth_server_scope

    id = jsonencode({

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

id             = "c5e12516-182c-4928-ae04-05374b3b1cca"

    })

    }

    The pulumi import command can be used, for example:

    $ pulumi import konnect:index/identityAuthServerScope:IdentityAuthServerScope my_konnect_identity_auth_server_scope '{"auth_server_id": "d32d905a-ed33-46a3-a093-d8f536af9a8a", "id": "c5e12516-182c-4928-ae04-05374b3b1cca"}'

    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.