Okta

v3.16.0 published on Wednesday, Sep 28, 2022 by Pulumi

ServerScope

Creates an Authorization Server Scope.

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

Example Usage

using System.Collections.Generic;
using Pulumi;
using Okta = Pulumi.Okta;

return await Deployment.RunAsync(() => 
{
    var example = new Okta.Auth.ServerScope("example", new()
    {
        AuthServerId = "<auth server id>",
        Consent = "IMPLICIT",
        MetadataPublish = "NO_CLIENTS",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auth.NewServerScope(ctx, "example", &auth.ServerScopeArgs{
			AuthServerId:    pulumi.String("<auth server id>"),
			Consent:         pulumi.String("IMPLICIT"),
			MetadataPublish: pulumi.String("NO_CLIENTS"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.auth.ServerScope;
import com.pulumi.okta.auth.ServerScopeArgs;
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 example = new ServerScope("example", ServerScopeArgs.builder()        
            .authServerId("<auth server id>")
            .consent("IMPLICIT")
            .metadataPublish("NO_CLIENTS")
            .build());

    }
}
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",
});
resources:
  example:
    type: okta:auth:ServerScope
    properties:
      authServerId: <auth server id>
      consent: IMPLICIT
      metadataPublish: NO_CLIENTS

Create a ServerScope Resource

new ServerScope(name: string, args: ServerScopeArgs, opts?: CustomResourceOptions);
@overload
def ServerScope(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                auth_server_id: Optional[str] = None,
                consent: Optional[str] = None,
                default: Optional[bool] = None,
                description: Optional[str] = None,
                display_name: Optional[str] = None,
                metadata_publish: Optional[str] = None,
                name: Optional[str] = None)
@overload
def ServerScope(resource_name: str,
                args: ServerScopeArgs,
                opts: Optional[ResourceOptions] = None)
func NewServerScope(ctx *Context, name string, args ServerScopeArgs, opts ...ResourceOption) (*ServerScope, error)
public ServerScope(string name, ServerScopeArgs args, CustomResourceOptions? opts = null)
public ServerScope(String name, ServerScopeArgs args)
public ServerScope(String name, ServerScopeArgs args, CustomResourceOptions options)
type: okta:auth:ServerScope
properties: # The arguments to resource properties.
options: # 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.
resource_name str
The unique name of the resource.
args ServerScopeArgs
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 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.
name String
The unique name of the resource.
args ServerScopeArgs
The arguments to resource properties.
options 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 Architecture and Concepts 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.

DisplayName string

Name of the end user displayed in a consent dialog box.

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.

DisplayName string

Name of the end user displayed in a consent dialog box.

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.

displayName String

Name of the end user displayed in a consent dialog box.

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.

displayName string

Name of the end user displayed in a consent dialog box.

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.

display_name str

Name of the end user displayed in a consent dialog box.

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.

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.

displayName String

Name of the end user displayed in a consent dialog box.

metadataPublish String

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

name String

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.

System bool

Whether Okta created the Scope

Id string

The provider-assigned unique ID for this managed resource.

System bool

Whether Okta created the Scope

id String

The provider-assigned unique ID for this managed resource.

system Boolean

Whether Okta created the Scope

id string

The provider-assigned unique ID for this managed resource.

system boolean

Whether Okta created the Scope

id str

The provider-assigned unique ID for this managed resource.

system bool

Whether Okta created the Scope

id String

The provider-assigned unique ID for this managed resource.

system Boolean

Whether Okta created the Scope

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
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_server_id: Optional[str] = None,
        consent: Optional[str] = None,
        default: Optional[bool] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        metadata_publish: Optional[str] = None,
        name: Optional[str] = None,
        system: Optional[bool] = None) -> ServerScope
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)
public static ServerScope get(String name, Output<String> id, ServerScopeState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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

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.

DisplayName string

Name of the end user displayed in a consent dialog box.

MetadataPublish string

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

Name string

Auth Server scope name.

System bool

Whether Okta created the Scope

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.

DisplayName string

Name of the end user displayed in a consent dialog box.

MetadataPublish string

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

Name string

Auth Server scope name.

System bool

Whether Okta created the Scope

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.

displayName String

Name of the end user displayed in a consent dialog box.

metadataPublish String

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

name String

Auth Server scope name.

system Boolean

Whether Okta created the Scope

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.

displayName string

Name of the end user displayed in a consent dialog box.

metadataPublish string

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

name string

Auth Server scope name.

system boolean

Whether Okta created the Scope

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.

display_name str

Name of the end user displayed in a consent dialog box.

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.

system bool

Whether Okta created the Scope

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.

displayName String

Name of the end user displayed in a consent dialog box.

metadataPublish String

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

name String

Auth Server scope name.

system Boolean

Whether Okta created the Scope

Import

Okta Auth Server Scope can be imported via the Auth Server ID and Scope ID.

 $ pulumi import okta:auth/serverScope:ServerScope example &#60;auth server id&#62;/&#60;scope id&#62;

Package Details

Repository
https://github.com/pulumi/pulumi-okta
License
Apache-2.0
Notes

This Pulumi package is based on the okta Terraform Provider.