Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Okta Provider
  3. API Docs
  4. auth
  5. getServerScopes
Okta v4.16.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-okta

okta.auth.getServerScopes

Explore with Pulumi AI

okta logo
Okta v4.16.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-okta

    Get a list of authorization server scopes from Okta.

    Example Usage

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

const test = okta.auth.getServerScopes({
    authServerId: "default",
});

    import pulumi
import pulumi_okta as okta

test = okta.auth.get_server_scopes(auth_server_id="default")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auth.GetServerScopes(ctx, &auth.GetServerScopesArgs{
			AuthServerId: "default",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var test = Okta.Auth.GetServerScopes.Invoke(new()
    {
        AuthServerId = "default",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.auth.AuthFunctions;
import com.pulumi.okta.auth.inputs.GetServerScopesArgs;
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) {
        final var test = AuthFunctions.getServerScopes(GetServerScopesArgs.builder()
            .authServerId("default")
            .build());

    }
}

    variables:
  test:
    fn::invoke:
      function: okta:auth:getServerScopes
      arguments:
        authServerId: default

    Using getServerScopes

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getServerScopes(args: GetServerScopesArgs, opts?: InvokeOptions): Promise<GetServerScopesResult>
function getServerScopesOutput(args: GetServerScopesOutputArgs, opts?: InvokeOptions): Output<GetServerScopesResult>
    def get_server_scopes(auth_server_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetServerScopesResult
def get_server_scopes_output(auth_server_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetServerScopesResult]
    func GetServerScopes(ctx *Context, args *GetServerScopesArgs, opts ...InvokeOption) (*GetServerScopesResult, error)
func GetServerScopesOutput(ctx *Context, args *GetServerScopesOutputArgs, opts ...InvokeOption) GetServerScopesResultOutput

    > Note: This function is named GetServerScopes in the Go SDK.

    public static class GetServerScopes 
{
    public static Task<GetServerScopesResult> InvokeAsync(GetServerScopesArgs args, InvokeOptions? opts = null)
    public static Output<GetServerScopesResult> Invoke(GetServerScopesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServerScopesResult> getServerScopes(GetServerScopesArgs args, InvokeOptions options)
public static Output<GetServerScopesResult> getServerScopes(GetServerScopesArgs args, InvokeOptions options)

    fn::invoke:
  function: okta:auth/getServerScopes:getServerScopes
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AuthServerId string
    Auth server ID
    AuthServerId string
    Auth server ID
    authServerId String
    Auth server ID
    authServerId string
    Auth server ID
    auth_server_id str
    Auth server ID
    authServerId String
    Auth server ID

    getServerScopes Result

    The following output properties are available:

    AuthServerId string
    Auth server ID
    Id string
    The provider-assigned unique ID for this managed resource.
    Scopes List<GetServerScopesScope>
    Collection of authorization server scopes retrieved from Okta with the following properties.
    AuthServerId string
    Auth server ID
    Id string
    The provider-assigned unique ID for this managed resource.
    Scopes []GetServerScopesScope
    Collection of authorization server scopes retrieved from Okta with the following properties.
    authServerId String
    Auth server ID
    id String
    The provider-assigned unique ID for this managed resource.
    scopes List<GetServerScopesScope>
    Collection of authorization server scopes retrieved from Okta with the following properties.
    authServerId string
    Auth server ID
    id string
    The provider-assigned unique ID for this managed resource.
    scopes GetServerScopesScope[]
    Collection of authorization server scopes retrieved from Okta with the following properties.
    auth_server_id str
    Auth server ID
    id str
    The provider-assigned unique ID for this managed resource.
    scopes Sequence[GetServerScopesScope]
    Collection of authorization server scopes retrieved from Okta with the following properties.
    authServerId String
    Auth server ID
    id String
    The provider-assigned unique ID for this managed resource.
    scopes List<Property Map>
    Collection of authorization server scopes retrieved from Okta with the following properties.

    Supporting Types

    GetServerScopesScope

    Consent string
    Indicates whether a consent dialog is needed for the Scope
    Default bool
    Whether the Scope is a default Scope
    Description string
    Description of the Scope
    DisplayName string
    Name of the end user displayed in a consent dialog box
    Id string
    ID of the Scope
    MetadataPublish string
    Whether the Scope should be included in the metadata
    Name string
    Name of the Scope
    Optional bool
    Whether the Scope is optional
    System bool
    Whether Okta created the Scope
    Consent string
    Indicates whether a consent dialog is needed for the Scope
    Default bool
    Whether the Scope is a default Scope
    Description string
    Description of the Scope
    DisplayName string
    Name of the end user displayed in a consent dialog box
    Id string
    ID of the Scope
    MetadataPublish string
    Whether the Scope should be included in the metadata
    Name string
    Name of the Scope
    Optional bool
    Whether the Scope is optional
    System bool
    Whether Okta created the Scope
    consent String
    Indicates whether a consent dialog is needed for the Scope
    default_ Boolean
    Whether the Scope is a default Scope
    description String
    Description of the Scope
    displayName String
    Name of the end user displayed in a consent dialog box
    id String
    ID of the Scope
    metadataPublish String
    Whether the Scope should be included in the metadata
    name String
    Name of the Scope
    optional Boolean
    Whether the Scope is optional
    system Boolean
    Whether Okta created the Scope
    consent string
    Indicates whether a consent dialog is needed for the Scope
    default boolean
    Whether the Scope is a default Scope
    description string
    Description of the Scope
    displayName string
    Name of the end user displayed in a consent dialog box
    id string
    ID of the Scope
    metadataPublish string
    Whether the Scope should be included in the metadata
    name string
    Name of the Scope
    optional boolean
    Whether the Scope is optional
    system boolean
    Whether Okta created the Scope
    consent str
    Indicates whether a consent dialog is needed for the Scope
    default bool
    Whether the Scope is a default Scope
    description str
    Description of the Scope
    display_name str
    Name of the end user displayed in a consent dialog box
    id str
    ID of the Scope
    metadata_publish str
    Whether the Scope should be included in the metadata
    name str
    Name of the Scope
    optional bool
    Whether the Scope is optional
    system bool
    Whether Okta created the Scope
    consent String
    Indicates whether a consent dialog is needed for the Scope
    default Boolean
    Whether the Scope is a default Scope
    description String
    Description of the Scope
    displayName String
    Name of the end user displayed in a consent dialog box
    id String
    ID of the Scope
    metadataPublish String
    Whether the Scope should be included in the metadata
    name String
    Name of the Scope
    optional Boolean
    Whether the Scope is optional
    system Boolean
    Whether Okta created the Scope

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v4.16.0 published on Wednesday, Apr 9, 2025 by Pulumi
    pulumi/pulumi-okta