Auth0

Pulumi Official
Package maintained by Pulumi
v2.8.0 published on Monday, Apr 4, 2022 by Pulumi

getClient

Data source to retrieve a specific Auth0 Application client by ‘client_id’ or ’name’

Example Usage

using Pulumi;
using Auth0 = Pulumi.Auth0;

class MyStack : Stack
{
    public MyStack()
    {
        var some_client_by_name = Output.Create(Auth0.GetClient.InvokeAsync(new Auth0.GetClientArgs
        {
            Name = "Name of my Application",
        }));
        var some_client_by_id = Output.Create(Auth0.GetClient.InvokeAsync(new Auth0.GetClientArgs
        {
            ClientId = "abcdefghkijklmnopqrstuvwxyz0123456789",
        }));
    }

}
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.LookupClient(ctx, &GetClientArgs{
			Name: pulumi.StringRef("Name of my Application"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = auth0.LookupClient(ctx, &GetClientArgs{
			ClientId: pulumi.StringRef("abcdefghkijklmnopqrstuvwxyz0123456789"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_auth0 as auth0

some_client_by_name = auth0.get_client(name="Name of my Application")
some_client_by_id = auth0.get_client(client_id="abcdefghkijklmnopqrstuvwxyz0123456789")
import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";

const some_client_by_name = pulumi.output(auth0.getClient({
    name: "Name of my Application",
}));
const some_client_by_id = pulumi.output(auth0.getClient({
    clientId: "abcdefghkijklmnopqrstuvwxyz0123456789",
}));

Coming soon!

Using getClient

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 getClient(args: GetClientArgs, opts?: InvokeOptions): Promise<GetClientResult>
function getClientOutput(args: GetClientOutputArgs, opts?: InvokeOptions): Output<GetClientResult>
def get_client(client_id: Optional[str] = None,
               name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetClientResult
def get_client_output(client_id: Optional[pulumi.Input[str]] = None,
               name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetClientResult]
func LookupClient(ctx *Context, args *LookupClientArgs, opts ...InvokeOption) (*LookupClientResult, error)
func LookupClientOutput(ctx *Context, args *LookupClientOutputArgs, opts ...InvokeOption) LookupClientResultOutput

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

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

The following arguments are supported:

ClientId string

String. client_id of the application.

Name string

String. Name of the application. Ignored if client_id is also specified.

ClientId string

String. client_id of the application.

Name string

String. Name of the application. Ignored if client_id is also specified.

clientId String

String. client_id of the application.

name String

String. Name of the application. Ignored if client_id is also specified.

clientId string

String. client_id of the application.

name string

String. Name of the application. Ignored if client_id is also specified.

client_id str

String. client_id of the application.

name str

String. Name of the application. Ignored if client_id is also specified.

clientId String

String. client_id of the application.

name String

String. Name of the application. Ignored if client_id is also specified.

getClient Result

The following output properties are available:

Addons List<GetClientAddon>
AllowedClients List<string>
AllowedLogoutUrls List<string>
AllowedOrigins List<string>
AppType string
Callbacks List<string>
ClientMetadata Dictionary<string, object>
ClientSecret string
CrossOriginAuth bool
CrossOriginLoc string
CustomLoginPage string
CustomLoginPageOn bool
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<GetClientJwtConfiguration>
LogoUri string
Mobiles List<GetClientMobile>
NativeSocialLogins List<GetClientNativeSocialLogin>
OidcConformant bool
OrganizationRequireBehavior string
OrganizationUsage string
RefreshTokens List<GetClientRefreshToken>
SigningKeys List<ImmutableDictionary<string, object>>
Sso bool
SsoDisabled bool
TokenEndpointAuthMethod string
WebOrigins List<string>
ClientId string
Name string
Addons []GetClientAddon
AllowedClients []string
AllowedLogoutUrls []string
AllowedOrigins []string
AppType string
Callbacks []string
ClientMetadata map[string]interface{}
ClientSecret string
CrossOriginAuth bool
CrossOriginLoc string
CustomLoginPage string
CustomLoginPageOn bool
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 []GetClientJwtConfiguration
LogoUri string
Mobiles []GetClientMobile
NativeSocialLogins []GetClientNativeSocialLogin
OidcConformant bool
OrganizationRequireBehavior string
OrganizationUsage string
RefreshTokens []GetClientRefreshToken
SigningKeys []map[string]interface{}
Sso bool
SsoDisabled bool
TokenEndpointAuthMethod string
WebOrigins []string
ClientId string
Name string
addons ListClientAddon>
allowedClients List
allowedLogoutUrls List
allowedOrigins List
appType String
callbacks List
clientMetadata Map
clientSecret String
crossOriginAuth Boolean
crossOriginLoc String
customLoginPage String
customLoginPageOn Boolean
description String
encryptionKey Map
formTemplate String
grantTypes List
id String

The provider-assigned unique ID for this managed resource.

initiateLoginUri String
isFirstParty Boolean
isTokenEndpointIpHeaderTrusted Boolean
jwtConfigurations ListClientJwtConfiguration>
logoUri String
mobiles ListClientMobile>
nativeSocialLogins ListClientNativeSocialLogin>
oidcConformant Boolean
organizationRequireBehavior String
organizationUsage String
refreshTokens ListClientRefreshToken>
signingKeys List>
sso Boolean
ssoDisabled Boolean
tokenEndpointAuthMethod String
webOrigins List
clientId String
name String
addons GetClientAddon[]
allowedClients string[]
allowedLogoutUrls string[]
allowedOrigins string[]
appType string
callbacks string[]
clientMetadata {[key: string]: any}
clientSecret string
crossOriginAuth boolean
crossOriginLoc string
customLoginPage string
customLoginPageOn boolean
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 GetClientJwtConfiguration[]
logoUri string
mobiles GetClientMobile[]
nativeSocialLogins GetClientNativeSocialLogin[]
oidcConformant boolean
organizationRequireBehavior string
organizationUsage string
refreshTokens GetClientRefreshToken[]
signingKeys {[key: string]: any}[]
sso boolean
ssoDisabled boolean
tokenEndpointAuthMethod string
webOrigins string[]
clientId string
name string
addons Sequence[GetClientAddon]
allowed_clients Sequence[str]
allowed_logout_urls Sequence[str]
allowed_origins Sequence[str]
app_type str
callbacks Sequence[str]
client_metadata Mapping[str, Any]
client_secret str
cross_origin_auth bool
cross_origin_loc str
custom_login_page str
custom_login_page_on bool
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[GetClientJwtConfiguration]
logo_uri str
mobiles Sequence[GetClientMobile]
native_social_logins Sequence[GetClientNativeSocialLogin]
oidc_conformant bool
organization_require_behavior str
organization_usage str
refresh_tokens Sequence[GetClientRefreshToken]
signing_keys Sequence[Mapping[str, Any]]
sso bool
sso_disabled bool
token_endpoint_auth_method str
web_origins Sequence[str]
client_id str
name str

Supporting Types

GetClientAddon

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<GetClientAddonSamlp>
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 []GetClientAddonSamlp
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}
samlps GetClientAddonSamlp[]
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[GetClientAddonSamlp]
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]

GetClientAddonSamlp

GetClientJwtConfiguration

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
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
secretEncoded Boolean

GetClientMobile

GetClientMobileAndroid

GetClientMobileIo

GetClientNativeSocialLogin

GetClientNativeSocialLoginApple

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

GetClientNativeSocialLoginFacebook

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

GetClientRefreshToken

Package Details

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

This Pulumi package is based on the auth0 Terraform Provider.