1. Packages
  2. Okta Provider
  3. API Docs
  4. auth
  5. getServer
Okta v4.11.1 published on Monday, Oct 7, 2024 by Pulumi

okta.auth.getServer

Explore with Pulumi AI

okta logo
Okta v4.11.1 published on Monday, Oct 7, 2024 by Pulumi

    Get an auth server from Okta.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = okta.auth.getServer({
        name: "Example Auth",
    });
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.auth.get_server(name="Example Auth")
    
    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.LookupServer(ctx, &auth.LookupServerArgs{
    			Name: "Example Auth",
    		}, 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 example = Okta.Auth.GetServer.Invoke(new()
        {
            Name = "Example Auth",
        });
    
    });
    
    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.GetServerArgs;
    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 example = AuthFunctions.getServer(GetServerArgs.builder()
                .name("Example Auth")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: okta:auth:getServer
          Arguments:
            name: Example Auth
    

    Using getServer

    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 getServer(args: GetServerArgs, opts?: InvokeOptions): Promise<GetServerResult>
    function getServerOutput(args: GetServerOutputArgs, opts?: InvokeOptions): Output<GetServerResult>
    def get_server(name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetServerResult
    def get_server_output(name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetServerResult]
    func LookupServer(ctx *Context, args *LookupServerArgs, opts ...InvokeOption) (*LookupServerResult, error)
    func LookupServerOutput(ctx *Context, args *LookupServerOutputArgs, opts ...InvokeOption) LookupServerResultOutput

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

    public static class GetServer 
    {
        public static Task<GetServerResult> InvokeAsync(GetServerArgs args, InvokeOptions? opts = null)
        public static Output<GetServerResult> Invoke(GetServerInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: okta:auth/getServer:getServer
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the auth server to retrieve.
    Name string
    The name of the auth server to retrieve.
    name String
    The name of the auth server to retrieve.
    name string
    The name of the auth server to retrieve.
    name str
    The name of the auth server to retrieve.
    name String
    The name of the auth server to retrieve.

    getServer Result

    The following output properties are available:

    Audiences List<string>
    Description of Authorization server.
    CredentialsLastRotated string
    Last time credentials were rotated.
    CredentialsNextRotation string
    Next time credentials will be rotated
    CredentialsRotationMode string
    Mode of credential rotation, auto or manual.
    Description string
    Description of Authorization server.
    Id string
    The provider-assigned unique ID for this managed resource.
    Issuer string
    The complete URL of the authorization server. This becomes the iss claim in an access token.
    IssuerMode string
    Can be set to CUSTOM_URL or ORG_URL
    Kid string
    Auth server key id.
    Name string
    The name of the auth server to retrieve.
    Status string
    The activation status of the authorization server.
    Audiences []string
    Description of Authorization server.
    CredentialsLastRotated string
    Last time credentials were rotated.
    CredentialsNextRotation string
    Next time credentials will be rotated
    CredentialsRotationMode string
    Mode of credential rotation, auto or manual.
    Description string
    Description of Authorization server.
    Id string
    The provider-assigned unique ID for this managed resource.
    Issuer string
    The complete URL of the authorization server. This becomes the iss claim in an access token.
    IssuerMode string
    Can be set to CUSTOM_URL or ORG_URL
    Kid string
    Auth server key id.
    Name string
    The name of the auth server to retrieve.
    Status string
    The activation status of the authorization server.
    audiences List<String>
    Description of Authorization server.
    credentialsLastRotated String
    Last time credentials were rotated.
    credentialsNextRotation String
    Next time credentials will be rotated
    credentialsRotationMode String
    Mode of credential rotation, auto or manual.
    description String
    Description of Authorization server.
    id String
    The provider-assigned unique ID for this managed resource.
    issuer String
    The complete URL of the authorization server. This becomes the iss claim in an access token.
    issuerMode String
    Can be set to CUSTOM_URL or ORG_URL
    kid String
    Auth server key id.
    name String
    The name of the auth server to retrieve.
    status String
    The activation status of the authorization server.
    audiences string[]
    Description of Authorization server.
    credentialsLastRotated string
    Last time credentials were rotated.
    credentialsNextRotation string
    Next time credentials will be rotated
    credentialsRotationMode string
    Mode of credential rotation, auto or manual.
    description string
    Description of Authorization server.
    id string
    The provider-assigned unique ID for this managed resource.
    issuer string
    The complete URL of the authorization server. This becomes the iss claim in an access token.
    issuerMode string
    Can be set to CUSTOM_URL or ORG_URL
    kid string
    Auth server key id.
    name string
    The name of the auth server to retrieve.
    status string
    The activation status of the authorization server.
    audiences Sequence[str]
    Description of Authorization server.
    credentials_last_rotated str
    Last time credentials were rotated.
    credentials_next_rotation str
    Next time credentials will be rotated
    credentials_rotation_mode str
    Mode of credential rotation, auto or manual.
    description str
    Description of Authorization server.
    id str
    The provider-assigned unique ID for this managed resource.
    issuer str
    The complete URL of the authorization server. This becomes the iss claim in an access token.
    issuer_mode str
    Can be set to CUSTOM_URL or ORG_URL
    kid str
    Auth server key id.
    name str
    The name of the auth server to retrieve.
    status str
    The activation status of the authorization server.
    audiences List<String>
    Description of Authorization server.
    credentialsLastRotated String
    Last time credentials were rotated.
    credentialsNextRotation String
    Next time credentials will be rotated
    credentialsRotationMode String
    Mode of credential rotation, auto or manual.
    description String
    Description of Authorization server.
    id String
    The provider-assigned unique ID for this managed resource.
    issuer String
    The complete URL of the authorization server. This becomes the iss claim in an access token.
    issuerMode String
    Can be set to CUSTOM_URL or ORG_URL
    kid String
    Auth server key id.
    name String
    The name of the auth server to retrieve.
    status String
    The activation status of the authorization server.

    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.11.1 published on Monday, Oct 7, 2024 by Pulumi