Auth0

Pulumi Official
Package maintained by Pulumi
v2.9.0 published on Thursday, May 26, 2022 by Pulumi

getGlobalClient

Retrieves a tenant’s global Auth0 Application client.

Example Usage

using Pulumi;
using Auth0 = Pulumi.Auth0;

class MyStack : Stack
{
    public MyStack()
    {
        var @global = Output.Create(Auth0.GetGlobalClient.InvokeAsync());
    }

}
package main

import (
	"github.com/pulumi/pulumi-auth0/sdk/v2/go/auth0"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auth0.LookupGlobalClient(ctx, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var global = Output.of(Auth0Functions.getGlobalClient());

    }
}
import pulumi
import pulumi_auth0 as auth0

global_ = auth0.get_global_client()
import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";

const global = pulumi.output(auth0.getGlobalClient());
variables:
  global:
    Fn::Invoke:
      Function: auth0:getGlobalClient
      Arguments: {}

Using getGlobalClient

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 getGlobalClient(args: GetGlobalClientArgs, opts?: InvokeOptions): Promise<GetGlobalClientResult>
function getGlobalClientOutput(args: GetGlobalClientOutputArgs, opts?: InvokeOptions): Output<GetGlobalClientResult>
def get_global_client(client_id: Optional[str] = None,
                      name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetGlobalClientResult
def get_global_client_output(client_id: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetGlobalClientResult]
func LookupGlobalClient(ctx *Context, args *LookupGlobalClientArgs, opts ...InvokeOption) (*LookupGlobalClientResult, error)
func LookupGlobalClientOutput(ctx *Context, args *LookupGlobalClientOutputArgs, opts ...InvokeOption) LookupGlobalClientResultOutput

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

public static class GetGlobalClient 
{
    public static Task<GetGlobalClientResult> InvokeAsync(GetGlobalClientArgs args, InvokeOptions? opts = null)
    public static Output<GetGlobalClientResult> Invoke(GetGlobalClientInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGlobalClientResult> getGlobalClient(GetGlobalClientArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: auth0:index/getGlobalClient:getGlobalClient
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ClientId string

String. ID of the client.

  • client_secret1 - String. Secret for the client; keep this private.
Name string
ClientId string

String. ID of the client.

  • client_secret1 - String. Secret for the client; keep this private.
Name string
clientId String

String. ID of the client.

  • client_secret1 - String. Secret for the client; keep this private.
name String
clientId string

String. ID of the client.

  • client_secret1 - String. Secret for the client; keep this private.
name string
client_id str

String. ID of the client.

  • client_secret1 - String. Secret for the client; keep this private.
name str
clientId String

String. ID of the client.

  • client_secret1 - String. Secret for the client; keep this private.
name String

getGlobalClient Result

The following output properties are available:

Addons List<GetGlobalClientAddon>
AllowedClients List<string>
AllowedLogoutUrls List<string>
AllowedOrigins List<string>
AppType string
Callbacks List<string>
ClientMetadata Dictionary<string, object>

(Optional) Map(String)

ClientSecret string
CrossOriginAuth bool
CrossOriginLoc string
CustomLoginPage string

String. Content of the custom login page.

CustomLoginPageOn bool

Boolean. Indicates whether a custom login page is to be used.

Description string
EncryptionKey Dictionary<string, string>
FormTemplate string
GrantTypes List<string>
Id string

The provider-assigned unique ID for this managed resource.

InitiateLoginUri string
IsFirstParty bool
IsTokenEndpointIpHeaderTrusted bool
JwtConfigurations List<GetGlobalClientJwtConfiguration>
LogoUri string
Mobiles List<GetGlobalClientMobile>
NativeSocialLogins List<GetGlobalClientNativeSocialLogin>
OidcConformant bool
OrganizationRequireBehavior string
OrganizationUsage string
RefreshTokens List<GetGlobalClientRefreshToken>
SigningKeys List<ImmutableDictionary<string, object>>
Sso bool
SsoDisabled bool
TokenEndpointAuthMethod string
WebOrigins List<string>
ClientId string

String. ID of the client.

  • client_secret1 - String. Secret for the client; keep this private.
Name string
Addons []GetGlobalClientAddon
AllowedClients []string
AllowedLogoutUrls []string
AllowedOrigins []string
AppType string
Callbacks []string
ClientMetadata map[string]interface{}

(Optional) Map(String)

ClientSecret string
CrossOriginAuth bool
CrossOriginLoc string
CustomLoginPage string

String. Content of the custom login page.

CustomLoginPageOn bool

Boolean. Indicates whether a custom login page is to be used.

Description string
EncryptionKey map[string]string
FormTemplate string
GrantTypes []string
Id string

The provider-assigned unique ID for this managed resource.

InitiateLoginUri string
IsFirstParty bool
IsTokenEndpointIpHeaderTrusted bool
JwtConfigurations []GetGlobalClientJwtConfiguration
LogoUri string
Mobiles []GetGlobalClientMobile
NativeSocialLogins []GetGlobalClientNativeSocialLogin
OidcConformant bool
OrganizationRequireBehavior string
OrganizationUsage string
RefreshTokens []GetGlobalClientRefreshToken
SigningKeys []map[string]interface{}
Sso bool
SsoDisabled bool
TokenEndpointAuthMethod string
WebOrigins []string
ClientId string

String. ID of the client.

  • client_secret1 - String. Secret for the client; keep this private.
Name string
addons List<GetGlobalClientAddon>
allowedClients List<String>
allowedLogoutUrls List<String>
allowedOrigins List<String>
appType String
callbacks List<String>
clientMetadata Map<String,Object>

(Optional) Map(String)

clientSecret String
crossOriginAuth Boolean
crossOriginLoc String
customLoginPage String

String. Content of the custom login page.

customLoginPageOn Boolean

Boolean. Indicates whether a custom login page is to be used.

description String
encryptionKey Map<String,String>
formTemplate String
grantTypes List<String>
id String

The provider-assigned unique ID for this managed resource.

initiateLoginUri String
isFirstParty Boolean
isTokenEndpointIpHeaderTrusted Boolean
jwtConfigurations List<GetGlobalClientJwtConfiguration>
logoUri String
mobiles List<GetGlobalClientMobile>
nativeSocialLogins List<GetGlobalClientNativeSocialLogin>
oidcConformant Boolean
organizationRequireBehavior String
organizationUsage String
refreshTokens List<GetGlobalClientRefreshToken>
signingKeys List<Map<String,Object>>
sso Boolean
ssoDisabled Boolean
tokenEndpointAuthMethod String
webOrigins List<String>
clientId String

String. ID of the client.

  • client_secret1 - String. Secret for the client; keep this private.
name String
addons GetGlobalClientAddon[]
allowedClients string[]
allowedLogoutUrls string[]
allowedOrigins string[]
appType string
callbacks string[]
clientMetadata {[key: string]: any}

(Optional) Map(String)

clientSecret string
crossOriginAuth boolean
crossOriginLoc string
customLoginPage string

String. Content of the custom login page.

customLoginPageOn boolean

Boolean. Indicates whether a custom login page is to be used.

description string
encryptionKey {[key: string]: string}
formTemplate string
grantTypes string[]
id string

The provider-assigned unique ID for this managed resource.

initiateLoginUri string
isFirstParty boolean
isTokenEndpointIpHeaderTrusted boolean
jwtConfigurations GetGlobalClientJwtConfiguration[]
logoUri string
mobiles GetGlobalClientMobile[]
nativeSocialLogins GetGlobalClientNativeSocialLogin[]
oidcConformant boolean
organizationRequireBehavior string
organizationUsage string
refreshTokens GetGlobalClientRefreshToken[]
signingKeys {[key: string]: any}[]
sso boolean
ssoDisabled boolean
tokenEndpointAuthMethod string
webOrigins string[]
clientId string

String. ID of the client.

  • client_secret1 - String. Secret for the client; keep this private.
name string
addons Sequence[GetGlobalClientAddon]
allowed_clients Sequence[str]
allowed_logout_urls Sequence[str]
allowed_origins Sequence[str]
app_type str
callbacks Sequence[str]
client_metadata Mapping[str, Any]

(Optional) Map(String)

client_secret str
cross_origin_auth bool
cross_origin_loc str
custom_login_page str

String. Content of the custom login page.

custom_login_page_on bool

Boolean. Indicates whether a custom login page is to be used.

description str
encryption_key Mapping[str, str]
form_template str
grant_types Sequence[str]
id str

The provider-assigned unique ID for this managed resource.

initiate_login_uri str
is_first_party bool
is_token_endpoint_ip_header_trusted bool
jwt_configurations Sequence[GetGlobalClientJwtConfiguration]
logo_uri str
mobiles Sequence[GetGlobalClientMobile]
native_social_logins Sequence[GetGlobalClientNativeSocialLogin]
oidc_conformant bool
organization_require_behavior str
organization_usage str
refresh_tokens Sequence[GetGlobalClientRefreshToken]
signing_keys Sequence[Mapping[str, Any]]
sso bool
sso_disabled bool
token_endpoint_auth_method str
web_origins Sequence[str]
client_id str

String. ID of the client.

  • client_secret1 - String. Secret for the client; keep this private.
name str
addons List<Property Map>
allowedClients List<String>
allowedLogoutUrls List<String>
allowedOrigins List<String>
appType String
callbacks List<String>
clientMetadata Map<Any>

(Optional) Map(String)

clientSecret String
crossOriginAuth Boolean
crossOriginLoc String
customLoginPage String

String. Content of the custom login page.

customLoginPageOn Boolean

Boolean. Indicates whether a custom login page is to be used.

description String
encryptionKey Map<String>
formTemplate String
grantTypes List<String>
id String

The provider-assigned unique ID for this managed resource.

initiateLoginUri String
isFirstParty Boolean
isTokenEndpointIpHeaderTrusted Boolean
jwtConfigurations List<Property Map>
logoUri String
mobiles List<Property Map>
nativeSocialLogins List<Property Map>
oidcConformant Boolean
organizationRequireBehavior String
organizationUsage String
refreshTokens List<Property Map>
signingKeys List<Map<Any>>
sso Boolean
ssoDisabled Boolean
tokenEndpointAuthMethod String
webOrigins List<String>
clientId String

String. ID of the client.

  • client_secret1 - String. Secret for the client; keep this private.
name String

Supporting Types

GetGlobalClientAddon

Aws Dictionary<string, object>
AzureBlob Dictionary<string, object>
AzureSb Dictionary<string, object>
Box Dictionary<string, object>
Cloudbees Dictionary<string, object>
Concur Dictionary<string, object>
Dropbox Dictionary<string, object>
Echosign Dictionary<string, object>
Egnyte Dictionary<string, object>
Firebase Dictionary<string, object>
Layer Dictionary<string, object>
Mscrm Dictionary<string, object>
Newrelic Dictionary<string, object>
Office365 Dictionary<string, object>
Rms Dictionary<string, object>
Salesforce Dictionary<string, object>
SalesforceApi Dictionary<string, object>
SalesforceSandboxApi Dictionary<string, object>
Samlps List<GetGlobalClientAddonSamlp>
SapApi Dictionary<string, object>
Sentry Dictionary<string, object>
Sharepoint Dictionary<string, object>
Slack Dictionary<string, object>
Springcm Dictionary<string, object>
Wams Dictionary<string, object>
Wsfed Dictionary<string, object>
Zendesk Dictionary<string, object>
Zoom Dictionary<string, object>
Aws map[string]interface{}
AzureBlob map[string]interface{}
AzureSb map[string]interface{}
Box map[string]interface{}
Cloudbees map[string]interface{}
Concur map[string]interface{}
Dropbox map[string]interface{}
Echosign map[string]interface{}
Egnyte map[string]interface{}
Firebase map[string]interface{}
Layer map[string]interface{}
Mscrm map[string]interface{}
Newrelic map[string]interface{}
Office365 map[string]interface{}
Rms map[string]interface{}
Salesforce map[string]interface{}
SalesforceApi map[string]interface{}
SalesforceSandboxApi map[string]interface{}
Samlps []GetGlobalClientAddonSamlp
SapApi map[string]interface{}
Sentry map[string]interface{}
Sharepoint map[string]interface{}
Slack map[string]interface{}
Springcm map[string]interface{}
Wams map[string]interface{}
Wsfed map[string]interface{}
Zendesk map[string]interface{}
Zoom map[string]interface{}
aws Map<String,Object>
azureBlob Map<String,Object>
azureSb Map<String,Object>
box Map<String,Object>
cloudbees Map<String,Object>
concur Map<String,Object>
dropbox Map<String,Object>
echosign Map<String,Object>
egnyte Map<String,Object>
firebase Map<String,Object>
layer Map<String,Object>
mscrm Map<String,Object>
newrelic Map<String,Object>
office365 Map<String,Object>
rms Map<String,Object>
salesforce Map<String,Object>
salesforceApi Map<String,Object>
salesforceSandboxApi Map<String,Object>
samlps List<GetGlobalClientAddonSamlp>
sapApi Map<String,Object>
sentry Map<String,Object>
sharepoint Map<String,Object>
slack Map<String,Object>
springcm Map<String,Object>
wams Map<String,Object>
wsfed Map<String,Object>
zendesk Map<String,Object>
zoom Map<String,Object>
aws {[key: string]: any}
azureBlob {[key: string]: any}
azureSb {[key: string]: any}
box {[key: string]: any}
cloudbees {[key: string]: any}
concur {[key: string]: any}
dropbox {[key: string]: any}
echosign {[key: string]: any}
egnyte {[key: string]: any}
firebase {[key: string]: any}
layer {[key: string]: any}
mscrm {[key: string]: any}
newrelic {[key: string]: any}
office365 {[key: string]: any}
rms {[key: string]: any}
salesforce {[key: string]: any}
salesforceApi {[key: string]: any}
salesforceSandboxApi {[key: string]: any}
samlps GetGlobalClientAddonSamlp[]
sapApi {[key: string]: any}
sentry {[key: string]: any}
sharepoint {[key: string]: any}
slack {[key: string]: any}
springcm {[key: string]: any}
wams {[key: string]: any}
wsfed {[key: string]: any}
zendesk {[key: string]: any}
zoom {[key: string]: any}
aws Mapping[str, Any]
azure_blob Mapping[str, Any]
azure_sb Mapping[str, Any]
box Mapping[str, Any]
cloudbees Mapping[str, Any]
concur Mapping[str, Any]
dropbox Mapping[str, Any]
echosign Mapping[str, Any]
egnyte Mapping[str, Any]
firebase Mapping[str, Any]
layer Mapping[str, Any]
mscrm Mapping[str, Any]
newrelic Mapping[str, Any]
office365 Mapping[str, Any]
rms Mapping[str, Any]
salesforce Mapping[str, Any]
salesforce_api Mapping[str, Any]
salesforce_sandbox_api Mapping[str, Any]
samlps Sequence[GetGlobalClientAddonSamlp]
sap_api Mapping[str, Any]
sentry Mapping[str, Any]
sharepoint Mapping[str, Any]
slack Mapping[str, Any]
springcm Mapping[str, Any]
wams Mapping[str, Any]
wsfed Mapping[str, Any]
zendesk Mapping[str, Any]
zoom Mapping[str, Any]
aws Map<Any>
azureBlob Map<Any>
azureSb Map<Any>
box Map<Any>
cloudbees Map<Any>
concur Map<Any>
dropbox Map<Any>
echosign Map<Any>
egnyte Map<Any>
firebase Map<Any>
layer Map<Any>
mscrm Map<Any>
newrelic Map<Any>
office365 Map<Any>
rms Map<Any>
salesforce Map<Any>
salesforceApi Map<Any>
salesforceSandboxApi Map<Any>
samlps List<Property Map>
sapApi Map<Any>
sentry Map<Any>
sharepoint Map<Any>
slack Map<Any>
springcm Map<Any>
wams Map<Any>
wsfed Map<Any>
zendesk Map<Any>
zoom Map<Any>

GetGlobalClientAddonSamlp

GetGlobalClientJwtConfiguration

Alg string
LifetimeInSeconds int
Scopes Dictionary<string, string>
SecretEncoded bool
Alg string
LifetimeInSeconds int
Scopes map[string]string
SecretEncoded bool
alg String
lifetimeInSeconds Integer
scopes Map<String,String>
secretEncoded Boolean
alg string
lifetimeInSeconds number
scopes {[key: string]: string}
secretEncoded boolean
alg str
lifetime_in_seconds int
scopes Mapping[str, str]
secret_encoded bool
alg String
lifetimeInSeconds Number
scopes Map<String>
secretEncoded Boolean

GetGlobalClientMobile

GetGlobalClientMobileAndroid

GetGlobalClientMobileIo

GetGlobalClientNativeSocialLogin

GetGlobalClientNativeSocialLoginApple

Enabled bool
Enabled bool
enabled Boolean
enabled boolean
enabled bool
enabled Boolean

GetGlobalClientNativeSocialLoginFacebook

Enabled bool
Enabled bool
enabled Boolean
enabled boolean
enabled bool
enabled Boolean

GetGlobalClientRefreshToken

Package Details

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

This Pulumi package is based on the auth0 Terraform Provider.