ServerScope

Creates an Authorization Server Scope.

This resource allows you to create and configure an Authorization Server Scope.

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Okta.Auth.ServerScope("example", new Okta.Auth.ServerScopeArgs
        {
            AuthServerId = "<auth server id>",
            Consent = "IMPLICIT",
            MetadataPublish = "NO_CLIENTS",
        });
    }

}

Coming soon!

import pulumi
import pulumi_okta as okta

example = okta.auth.ServerScope("example",
    auth_server_id="<auth server id>",
    consent="IMPLICIT",
    metadata_publish="NO_CLIENTS")

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

const example = new okta.auth.ServerScope("example", {
    authServerId: "<auth server id>",
    consent: "IMPLICIT",
    metadataPublish: "NO_CLIENTS",
});

Create a ServerScope Resource

new ServerScope(name: string, args: ServerScopeArgs, opts?: CustomResourceOptions);

def ServerScope(resource_name, opts=None, auth_server_id=None, consent=None, default=None, description=None, metadata_publish=None, name=None, __props__=None);

func NewServerScope(ctx *Context, name string, args ServerScopeArgs, opts ...ResourceOption) (*ServerScope, error)

public ServerScope(string name, ServerScopeArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ServerScopeArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ServerScopeArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ServerScopeArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

ServerScope Resource Properties

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

Inputs

The ServerScope resource accepts the following input properties:

AuthServerId string: Auth Server ID.
Consent string: Indicates whether a consent dialog is needed for the scope. It can be set to "REQUIRED" or "IMPLICIT".
Default bool: A default scope will be returned in an access token when the client omits the scope parameter in a token request, provided this scope is allowed as part of the access policy rule.
Description string: Description of the Auth Server Scope.
MetadataPublish string: Whether to publish metadata or not. It can be set to "ALL_CLIENTS" or "NO_CLIENTS".
Name string: Auth Server scope name.

AuthServerId string: Auth Server ID.
Consent string: Indicates whether a consent dialog is needed for the scope. It can be set to "REQUIRED" or "IMPLICIT".
Default bool: A default scope will be returned in an access token when the client omits the scope parameter in a token request, provided this scope is allowed as part of the access policy rule.
Description string: Description of the Auth Server Scope.
MetadataPublish string: Whether to publish metadata or not. It can be set to "ALL_CLIENTS" or "NO_CLIENTS".
Name string: Auth Server scope name.

authServerId string: Auth Server ID.
consent string: Indicates whether a consent dialog is needed for the scope. It can be set to "REQUIRED" or "IMPLICIT".
default boolean: A default scope will be returned in an access token when the client omits the scope parameter in a token request, provided this scope is allowed as part of the access policy rule.
description string: Description of the Auth Server Scope.
metadataPublish string: Whether to publish metadata or not. It can be set to "ALL_CLIENTS" or "NO_CLIENTS".
name string: Auth Server scope name.

auth_server_id str: Auth Server ID.
consent str: Indicates whether a consent dialog is needed for the scope. It can be set to "REQUIRED" or "IMPLICIT".
default bool: A default scope will be returned in an access token when the client omits the scope parameter in a token request, provided this scope is allowed as part of the access policy rule.
description str: Description of the Auth Server Scope.
metadata_publish str: Whether to publish metadata or not. It can be set to "ALL_CLIENTS" or "NO_CLIENTS".
name str: Auth Server scope name.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing ServerScope Resource

Get an existing ServerScope 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?: ServerScopeState, opts?: CustomResourceOptions): ServerScope

static get(resource_name, id, opts=None, auth_server_id=None, consent=None, default=None, description=None, metadata_publish=None, name=None, __props__=None);

func GetServerScope(ctx *Context, name string, id IDInput, state *ServerScopeState, opts ...ResourceOption) (*ServerScope, error)

public static ServerScope Get(string name, Input<string> id, ServerScopeState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

AuthServerId string: Auth Server ID.
Consent string: Indicates whether a consent dialog is needed for the scope. It can be set to "REQUIRED" or "IMPLICIT".
Default bool: A default scope will be returned in an access token when the client omits the scope parameter in a token request, provided this scope is allowed as part of the access policy rule.
Description string: Description of the Auth Server Scope.
MetadataPublish string: Whether to publish metadata or not. It can be set to "ALL_CLIENTS" or "NO_CLIENTS".
Name string: Auth Server scope name.

AuthServerId string: Auth Server ID.
Consent string: Indicates whether a consent dialog is needed for the scope. It can be set to "REQUIRED" or "IMPLICIT".
Default bool: A default scope will be returned in an access token when the client omits the scope parameter in a token request, provided this scope is allowed as part of the access policy rule.
Description string: Description of the Auth Server Scope.
MetadataPublish string: Whether to publish metadata or not. It can be set to "ALL_CLIENTS" or "NO_CLIENTS".
Name string: Auth Server scope name.

authServerId string: Auth Server ID.
consent string: Indicates whether a consent dialog is needed for the scope. It can be set to "REQUIRED" or "IMPLICIT".
default boolean: A default scope will be returned in an access token when the client omits the scope parameter in a token request, provided this scope is allowed as part of the access policy rule.
description string: Description of the Auth Server Scope.
metadataPublish string: Whether to publish metadata or not. It can be set to "ALL_CLIENTS" or "NO_CLIENTS".
name string: Auth Server scope name.

auth_server_id str: Auth Server ID.
consent str: Indicates whether a consent dialog is needed for the scope. It can be set to "REQUIRED" or "IMPLICIT".
default bool: A default scope will be returned in an access token when the client omits the scope parameter in a token request, provided this scope is allowed as part of the access policy rule.
description str: Description of the Auth Server Scope.
metadata_publish str: Whether to publish metadata or not. It can be set to "ALL_CLIENTS" or "NO_CLIENTS".
name str: Auth Server scope name.

Package Details

Repository: https://github.com/pulumi/pulumi-okta
License: Apache-2.0
Notes: This Pulumi package is based on the okta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud