1. Docs
  2. Reference
  3. API
  4. auth0
  5. GlobalClient

GlobalClient

Create a GlobalClient Resource

new GlobalClient(name: string, args?: GlobalClientArgs, opts?: CustomResourceOptions);
def GlobalClient(resource_name, opts=None, addons=None, allowed_logout_urls=None, allowed_origins=None, app_type=None, callbacks=None, client_metadata=None, client_secret_rotation_trigger=None, cross_origin_auth=None, cross_origin_loc=None, custom_login_page=None, custom_login_page_on=None, custom_login_page_preview=None, description=None, encryption_key=None, form_template=None, grant_types=None, initiate_login_uri=None, is_first_party=None, is_token_endpoint_ip_header_trusted=None, jwt_configuration=None, logo_uri=None, mobile=None, oidc_conformant=None, sso=None, sso_disabled=None, token_endpoint_auth_method=None, web_origins=None, __props__=None);
func NewGlobalClient(ctx *Context, name string, args *GlobalClientArgs, opts ...ResourceOption) (*GlobalClient, error)
public GlobalClient(string name, GlobalClientArgs? args = null, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args GlobalClientArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args GlobalClientArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GlobalClientArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

GlobalClient Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The GlobalClient resource accepts the following input properties:

Addons GlobalClientAddonsArgs
AllowedLogoutUrls List<string>
AllowedOrigins List<string>
AppType string
Callbacks List<string>
ClientMetadata Dictionary<string, object>
ClientSecretRotationTrigger Dictionary<string, object>
CrossOriginAuth bool
CrossOriginLoc string
CustomLoginPage string
CustomLoginPageOn bool
CustomLoginPagePreview string
Description string
EncryptionKey Dictionary<string, string>
FormTemplate string
GrantTypes List<string>
InitiateLoginUri string
IsFirstParty bool
IsTokenEndpointIpHeaderTrusted bool
JwtConfiguration GlobalClientJwtConfigurationArgs
LogoUri string
Mobile GlobalClientMobileArgs
OidcConformant bool
Sso bool
SsoDisabled bool
TokenEndpointAuthMethod string
WebOrigins List<string>
Addons GlobalClientAddons
AllowedLogoutUrls []string
AllowedOrigins []string
AppType string
Callbacks []string
ClientMetadata map[string]interface{}
ClientSecretRotationTrigger map[string]interface{}
CrossOriginAuth bool
CrossOriginLoc string
CustomLoginPage string
CustomLoginPageOn bool
CustomLoginPagePreview string
Description string
EncryptionKey map[string]string
FormTemplate string
GrantTypes []string
InitiateLoginUri string
IsFirstParty bool
IsTokenEndpointIpHeaderTrusted bool
JwtConfiguration GlobalClientJwtConfiguration
LogoUri string
Mobile GlobalClientMobile
OidcConformant bool
Sso bool
SsoDisabled bool
TokenEndpointAuthMethod string
WebOrigins []string
addons GlobalClientAddons
allowedLogoutUrls string[]
allowedOrigins string[]
appType string
callbacks string[]
clientMetadata {[key: string]: any}
clientSecretRotationTrigger {[key: string]: any}
crossOriginAuth boolean
crossOriginLoc string
customLoginPage string
customLoginPageOn boolean
customLoginPagePreview string
description string
encryptionKey {[key: string]: string}
formTemplate string
grantTypes string[]
initiateLoginUri string
isFirstParty boolean
isTokenEndpointIpHeaderTrusted boolean
jwtConfiguration GlobalClientJwtConfiguration
logoUri string
mobile GlobalClientMobile
oidcConformant boolean
sso boolean
ssoDisabled boolean
tokenEndpointAuthMethod string
webOrigins string[]
addons Dict[GlobalClientAddons]
allowed_logout_urls List[str]
allowed_origins List[str]
app_type str
callbacks List[str]
client_metadata Dict[str, Any]
client_secret_rotation_trigger Dict[str, Any]
cross_origin_auth bool
cross_origin_loc str
custom_login_page str
custom_login_page_on bool
custom_login_page_preview str
description str
encryption_key Dict[str, str]
form_template str
grant_types List[str]
initiate_login_uri str
is_first_party bool
is_token_endpoint_ip_header_trusted bool
jwt_configuration Dict[GlobalClientJwtConfiguration]
logo_uri str
mobile Dict[GlobalClientMobile]
oidc_conformant bool
sso bool
sso_disabled bool
token_endpoint_auth_method str
web_origins List[str]

Outputs

All input properties are implicitly available as output properties. Additionally, the GlobalClient resource produces the following output properties:

ClientId string
ClientSecret string
Id string
The provider-assigned unique ID for this managed resource.
Name string
ClientId string
ClientSecret string
Id string
The provider-assigned unique ID for this managed resource.
Name string
clientId string
clientSecret string
id string
The provider-assigned unique ID for this managed resource.
name string
client_id str
client_secret str
id str
The provider-assigned unique ID for this managed resource.
name str

Look up an Existing GlobalClient Resource

Get an existing GlobalClient 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?: GlobalClientState, opts?: CustomResourceOptions): GlobalClient
static get(resource_name, id, opts=None, addons=None, allowed_logout_urls=None, allowed_origins=None, app_type=None, callbacks=None, client_id=None, client_metadata=None, client_secret=None, client_secret_rotation_trigger=None, cross_origin_auth=None, cross_origin_loc=None, custom_login_page=None, custom_login_page_on=None, custom_login_page_preview=None, description=None, encryption_key=None, form_template=None, grant_types=None, initiate_login_uri=None, is_first_party=None, is_token_endpoint_ip_header_trusted=None, jwt_configuration=None, logo_uri=None, mobile=None, name=None, oidc_conformant=None, sso=None, sso_disabled=None, token_endpoint_auth_method=None, web_origins=None, __props__=None);
func GetGlobalClient(ctx *Context, name string, id IDInput, state *GlobalClientState, opts ...ResourceOption) (*GlobalClient, error)
public static GlobalClient Get(string name, Input<string> id, GlobalClientState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

Addons GlobalClientAddonsArgs
AllowedLogoutUrls List<string>
AllowedOrigins List<string>
AppType string
Callbacks List<string>
ClientId string
ClientMetadata Dictionary<string, object>
ClientSecret string
ClientSecretRotationTrigger Dictionary<string, object>
CrossOriginAuth bool
CrossOriginLoc string
CustomLoginPage string
CustomLoginPageOn bool
CustomLoginPagePreview string
Description string
EncryptionKey Dictionary<string, string>
FormTemplate string
GrantTypes List<string>
InitiateLoginUri string
IsFirstParty bool
IsTokenEndpointIpHeaderTrusted bool
JwtConfiguration GlobalClientJwtConfigurationArgs
LogoUri string
Mobile GlobalClientMobileArgs
Name string
OidcConformant bool
Sso bool
SsoDisabled bool
TokenEndpointAuthMethod string
WebOrigins List<string>
Addons GlobalClientAddons
AllowedLogoutUrls []string
AllowedOrigins []string
AppType string
Callbacks []string
ClientId string
ClientMetadata map[string]interface{}
ClientSecret string
ClientSecretRotationTrigger map[string]interface{}
CrossOriginAuth bool
CrossOriginLoc string
CustomLoginPage string
CustomLoginPageOn bool
CustomLoginPagePreview string
Description string
EncryptionKey map[string]string
FormTemplate string
GrantTypes []string
InitiateLoginUri string
IsFirstParty bool
IsTokenEndpointIpHeaderTrusted bool
JwtConfiguration GlobalClientJwtConfiguration
LogoUri string
Mobile GlobalClientMobile
Name string
OidcConformant bool
Sso bool
SsoDisabled bool
TokenEndpointAuthMethod string
WebOrigins []string
addons GlobalClientAddons
allowedLogoutUrls string[]
allowedOrigins string[]
appType string
callbacks string[]
clientId string
clientMetadata {[key: string]: any}
clientSecret string
clientSecretRotationTrigger {[key: string]: any}
crossOriginAuth boolean
crossOriginLoc string
customLoginPage string
customLoginPageOn boolean
customLoginPagePreview string
description string
encryptionKey {[key: string]: string}
formTemplate string
grantTypes string[]
initiateLoginUri string
isFirstParty boolean
isTokenEndpointIpHeaderTrusted boolean
jwtConfiguration GlobalClientJwtConfiguration
logoUri string
mobile GlobalClientMobile
name string
oidcConformant boolean
sso boolean
ssoDisabled boolean
tokenEndpointAuthMethod string
webOrigins string[]
addons Dict[GlobalClientAddons]
allowed_logout_urls List[str]
allowed_origins List[str]
app_type str
callbacks List[str]
client_id str
client_metadata Dict[str, Any]
client_secret str
client_secret_rotation_trigger Dict[str, Any]
cross_origin_auth bool
cross_origin_loc str
custom_login_page str
custom_login_page_on bool
custom_login_page_preview str
description str
encryption_key Dict[str, str]
form_template str
grant_types List[str]
initiate_login_uri str
is_first_party bool
is_token_endpoint_ip_header_trusted bool
jwt_configuration Dict[GlobalClientJwtConfiguration]
logo_uri str
mobile Dict[GlobalClientMobile]
name str
oidc_conformant bool
sso bool
sso_disabled bool
token_endpoint_auth_method str
web_origins List[str]

Supporting Types

GlobalClientAddons

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

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>
Samlp GlobalClientAddonsSamlpArgs
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{}
Samlp GlobalClientAddonsSamlp
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 {[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}
samlp GlobalClientAddonsSamlp
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 Dict[str, Any]
azureBlob Dict[str, Any]
azureSb Dict[str, Any]
box Dict[str, Any]
cloudbees Dict[str, Any]
concur Dict[str, Any]
dropbox Dict[str, Any]
echosign Dict[str, Any]
egnyte Dict[str, Any]
firebase Dict[str, Any]
layer Dict[str, Any]
mscrm Dict[str, Any]
newrelic Dict[str, Any]
office365 Dict[str, Any]
rms Dict[str, Any]
salesforce Dict[str, Any]
salesforceApi Dict[str, Any]
salesforceSandboxApi Dict[str, Any]
samlp Dict[GlobalClientAddonsSamlp]
sapApi Dict[str, Any]
sentry Dict[str, Any]
sharepoint Dict[str, Any]
slack Dict[str, Any]
springcm Dict[str, Any]
wams Dict[str, Any]
wsfed Dict[str, Any]
zendesk Dict[str, Any]
zoom Dict[str, Any]

GlobalClientAddonsSamlp

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Audience string
AuthnContextClassRef string
Binding string
CreateUpnClaim bool
Destination string
DigestAlgorithm string
IncludeAttributeNameFormat bool
LifetimeInSeconds int
Logout GlobalClientAddonsSamlpLogoutArgs
MapIdentities bool
MapUnknownClaimsAsIs bool
Mappings Dictionary<string, object>
NameIdentifierFormat string
NameIdentifierProbes List<string>
PassthroughClaimsWithNoMapping bool
Recipient string
SignResponse bool
SignatureAlgorithm string
TypedAttributes bool
Audience string
AuthnContextClassRef string
Binding string
CreateUpnClaim bool
Destination string
DigestAlgorithm string
IncludeAttributeNameFormat bool
LifetimeInSeconds int
Logout GlobalClientAddonsSamlpLogout
MapIdentities bool
MapUnknownClaimsAsIs bool
Mappings map[string]interface{}
NameIdentifierFormat string
NameIdentifierProbes []string
PassthroughClaimsWithNoMapping bool
Recipient string
SignResponse bool
SignatureAlgorithm string
TypedAttributes bool
audience string
authnContextClassRef string
binding string
createUpnClaim boolean
destination string
digestAlgorithm string
includeAttributeNameFormat boolean
lifetimeInSeconds number
logout GlobalClientAddonsSamlpLogout
mapIdentities boolean
mapUnknownClaimsAsIs boolean
mappings {[key: string]: any}
nameIdentifierFormat string
nameIdentifierProbes string[]
passthroughClaimsWithNoMapping boolean
recipient string
signResponse boolean
signatureAlgorithm string
typedAttributes boolean
audience str
authnContextClassRef str
binding str
createUpnClaim bool
destination str
digestAlgorithm str
includeAttributeNameFormat bool
lifetimeInSeconds float
logout Dict[GlobalClientAddonsSamlpLogout]
mapIdentities bool
mapUnknownClaimsAsIs bool
mappings Dict[str, Any]
nameIdentifierFormat str
nameIdentifierProbes List[str]
passthroughClaimsWithNoMapping bool
recipient str
signResponse bool
signatureAlgorithm str
typedAttributes bool

GlobalClientAddonsSamlpLogout

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Callback string
SloEnabled bool
Callback string
SloEnabled bool
callback string
sloEnabled boolean
callback str
sloEnabled bool

GlobalClientJwtConfiguration

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Alg string
LifetimeInSeconds int
Scopes Dictionary<string, string>
SecretEncoded bool
Alg string
LifetimeInSeconds int
Scopes map[string]string
SecretEncoded bool
alg string
lifetimeInSeconds number
scopes {[key: string]: string}
secretEncoded boolean
alg str
lifetimeInSeconds float
scopes Dict[str, str]
secretEncoded bool

GlobalClientMobile

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Android GlobalClientMobileAndroidArgs
Ios GlobalClientMobileIosArgs
Android GlobalClientMobileAndroid
Ios GlobalClientMobileIos
android GlobalClientMobileAndroid
ios GlobalClientMobileIos
android Dict[GlobalClientMobileAndroid]
ios Dict[GlobalClientMobileIos]

GlobalClientMobileAndroid

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

AppPackageName string
Sha256CertFingerprints List<string>
AppPackageName string
Sha256CertFingerprints []string
appPackageName string
sha256CertFingerprints string[]
appPackageName str
sha256CertFingerprints List[str]

GlobalClientMobileIos

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

AppBundleIdentifier string
TeamId string
AppBundleIdentifier string
TeamId string
appBundleIdentifier string
teamId string
appBundleIdentifier str
teamId str

Package Details

Repository
https://github.com/pulumi/pulumi-auth0
License
Apache-2.0
Notes
This Pulumi package is based on the auth0 Terraform Provider.