Class 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",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

ServerScope

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Okta.Auth

Assembly: Pulumi.Okta.dll

Syntax

public class ServerScope : CustomResource

Constructors

ServerScope(String, ServerScopeArgs, CustomResourceOptions)

Create a ServerScope resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ServerScopeArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AuthServerId

Auth Server ID.

Declaration

public Output<string> AuthServerId { get; }

Property Value

Type	Description
Output<System.String>

Consent

Indicates whether a consent dialog is needed for the scope. It can be set to "REQUIRED" or "IMPLICIT".

Declaration

public Output<string> Consent { get; }

Property Value

Type	Description
Output<System.String>

Default

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.

Declaration

public Output<bool?> Default { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Description

Description of the Auth Server Scope.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

MetadataPublish

Whether to publish metadata or not. It can be set to "ALL_CLIENTS" or "NO_CLIENTS".

Declaration

public Output<string> MetadataPublish { get; }

Property Value

Type	Description
Output<System.String>

Name

Auth Server scope name.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, ServerScopeState, CustomResourceOptions)

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

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ServerScopeState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ServerScope