auth0.ClientCredentials
Explore with Pulumi AI
With this resource, you can configure the method to use when making requests to any endpoint that requires this client to authenticate.
Refer to the client secret rotation guide for instructions on how to rotate client secrets with zero downtime.
Create ClientCredentials Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ClientCredentials(name: string, args: ClientCredentialsArgs, opts?: CustomResourceOptions);
@overload
def ClientCredentials(resource_name: str,
args: ClientCredentialsArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ClientCredentials(resource_name: str,
opts: Optional[ResourceOptions] = None,
client_id: Optional[str] = None,
authentication_method: Optional[str] = None,
client_secret: Optional[str] = None,
private_key_jwt: Optional[ClientCredentialsPrivateKeyJwtArgs] = None,
self_signed_tls_client_auth: Optional[ClientCredentialsSelfSignedTlsClientAuthArgs] = None,
signed_request_object: Optional[ClientCredentialsSignedRequestObjectArgs] = None,
tls_client_auth: Optional[ClientCredentialsTlsClientAuthArgs] = None)
func NewClientCredentials(ctx *Context, name string, args ClientCredentialsArgs, opts ...ResourceOption) (*ClientCredentials, error)
public ClientCredentials(string name, ClientCredentialsArgs args, CustomResourceOptions? opts = null)
public ClientCredentials(String name, ClientCredentialsArgs args)
public ClientCredentials(String name, ClientCredentialsArgs args, CustomResourceOptions options)
type: auth0:ClientCredentials
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ClientCredentialsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ClientCredentialsArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ClientCredentialsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClientCredentialsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClientCredentialsArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var clientCredentialsResource = new Auth0.ClientCredentials("clientCredentialsResource", new()
{
ClientId = "string",
AuthenticationMethod = "string",
ClientSecret = "string",
PrivateKeyJwt = new Auth0.Inputs.ClientCredentialsPrivateKeyJwtArgs
{
Credentials = new[]
{
new Auth0.Inputs.ClientCredentialsPrivateKeyJwtCredentialArgs
{
CredentialType = "string",
Pem = "string",
Algorithm = "string",
CreatedAt = "string",
ExpiresAt = "string",
Id = "string",
KeyId = "string",
Name = "string",
ParseExpiryFromCert = false,
UpdatedAt = "string",
},
},
},
SelfSignedTlsClientAuth = new Auth0.Inputs.ClientCredentialsSelfSignedTlsClientAuthArgs
{
Credentials = new[]
{
new Auth0.Inputs.ClientCredentialsSelfSignedTlsClientAuthCredentialArgs
{
Pem = "string",
CreatedAt = "string",
CredentialType = "string",
ExpiresAt = "string",
Id = "string",
Name = "string",
ThumbprintSha256 = "string",
UpdatedAt = "string",
},
},
},
SignedRequestObject = new Auth0.Inputs.ClientCredentialsSignedRequestObjectArgs
{
Credentials = new[]
{
new Auth0.Inputs.ClientCredentialsSignedRequestObjectCredentialArgs
{
CredentialType = "string",
Pem = "string",
Algorithm = "string",
CreatedAt = "string",
ExpiresAt = "string",
Id = "string",
KeyId = "string",
Name = "string",
ParseExpiryFromCert = false,
UpdatedAt = "string",
},
},
Required = false,
},
TlsClientAuth = new Auth0.Inputs.ClientCredentialsTlsClientAuthArgs
{
Credentials = new[]
{
new Auth0.Inputs.ClientCredentialsTlsClientAuthCredentialArgs
{
CredentialType = "string",
CreatedAt = "string",
Id = "string",
Name = "string",
Pem = "string",
SubjectDn = "string",
UpdatedAt = "string",
},
},
},
});
example, err := auth0.NewClientCredentials(ctx, "clientCredentialsResource", &auth0.ClientCredentialsArgs{
ClientId: pulumi.String("string"),
AuthenticationMethod: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
PrivateKeyJwt: &auth0.ClientCredentialsPrivateKeyJwtArgs{
Credentials: auth0.ClientCredentialsPrivateKeyJwtCredentialArray{
&auth0.ClientCredentialsPrivateKeyJwtCredentialArgs{
CredentialType: pulumi.String("string"),
Pem: pulumi.String("string"),
Algorithm: pulumi.String("string"),
CreatedAt: pulumi.String("string"),
ExpiresAt: pulumi.String("string"),
Id: pulumi.String("string"),
KeyId: pulumi.String("string"),
Name: pulumi.String("string"),
ParseExpiryFromCert: pulumi.Bool(false),
UpdatedAt: pulumi.String("string"),
},
},
},
SelfSignedTlsClientAuth: &auth0.ClientCredentialsSelfSignedTlsClientAuthArgs{
Credentials: auth0.ClientCredentialsSelfSignedTlsClientAuthCredentialArray{
&auth0.ClientCredentialsSelfSignedTlsClientAuthCredentialArgs{
Pem: pulumi.String("string"),
CreatedAt: pulumi.String("string"),
CredentialType: pulumi.String("string"),
ExpiresAt: pulumi.String("string"),
Id: pulumi.String("string"),
Name: pulumi.String("string"),
ThumbprintSha256: pulumi.String("string"),
UpdatedAt: pulumi.String("string"),
},
},
},
SignedRequestObject: &auth0.ClientCredentialsSignedRequestObjectArgs{
Credentials: auth0.ClientCredentialsSignedRequestObjectCredentialArray{
&auth0.ClientCredentialsSignedRequestObjectCredentialArgs{
CredentialType: pulumi.String("string"),
Pem: pulumi.String("string"),
Algorithm: pulumi.String("string"),
CreatedAt: pulumi.String("string"),
ExpiresAt: pulumi.String("string"),
Id: pulumi.String("string"),
KeyId: pulumi.String("string"),
Name: pulumi.String("string"),
ParseExpiryFromCert: pulumi.Bool(false),
UpdatedAt: pulumi.String("string"),
},
},
Required: pulumi.Bool(false),
},
TlsClientAuth: &auth0.ClientCredentialsTlsClientAuthArgs{
Credentials: auth0.ClientCredentialsTlsClientAuthCredentialArray{
&auth0.ClientCredentialsTlsClientAuthCredentialArgs{
CredentialType: pulumi.String("string"),
CreatedAt: pulumi.String("string"),
Id: pulumi.String("string"),
Name: pulumi.String("string"),
Pem: pulumi.String("string"),
SubjectDn: pulumi.String("string"),
UpdatedAt: pulumi.String("string"),
},
},
},
})
var clientCredentialsResource = new ClientCredentials("clientCredentialsResource", ClientCredentialsArgs.builder()
.clientId("string")
.authenticationMethod("string")
.clientSecret("string")
.privateKeyJwt(ClientCredentialsPrivateKeyJwtArgs.builder()
.credentials(ClientCredentialsPrivateKeyJwtCredentialArgs.builder()
.credentialType("string")
.pem("string")
.algorithm("string")
.createdAt("string")
.expiresAt("string")
.id("string")
.keyId("string")
.name("string")
.parseExpiryFromCert(false)
.updatedAt("string")
.build())
.build())
.selfSignedTlsClientAuth(ClientCredentialsSelfSignedTlsClientAuthArgs.builder()
.credentials(ClientCredentialsSelfSignedTlsClientAuthCredentialArgs.builder()
.pem("string")
.createdAt("string")
.credentialType("string")
.expiresAt("string")
.id("string")
.name("string")
.thumbprintSha256("string")
.updatedAt("string")
.build())
.build())
.signedRequestObject(ClientCredentialsSignedRequestObjectArgs.builder()
.credentials(ClientCredentialsSignedRequestObjectCredentialArgs.builder()
.credentialType("string")
.pem("string")
.algorithm("string")
.createdAt("string")
.expiresAt("string")
.id("string")
.keyId("string")
.name("string")
.parseExpiryFromCert(false)
.updatedAt("string")
.build())
.required(false)
.build())
.tlsClientAuth(ClientCredentialsTlsClientAuthArgs.builder()
.credentials(ClientCredentialsTlsClientAuthCredentialArgs.builder()
.credentialType("string")
.createdAt("string")
.id("string")
.name("string")
.pem("string")
.subjectDn("string")
.updatedAt("string")
.build())
.build())
.build());
client_credentials_resource = auth0.ClientCredentials("clientCredentialsResource",
client_id="string",
authentication_method="string",
client_secret="string",
private_key_jwt={
"credentials": [{
"credential_type": "string",
"pem": "string",
"algorithm": "string",
"created_at": "string",
"expires_at": "string",
"id": "string",
"key_id": "string",
"name": "string",
"parse_expiry_from_cert": False,
"updated_at": "string",
}],
},
self_signed_tls_client_auth={
"credentials": [{
"pem": "string",
"created_at": "string",
"credential_type": "string",
"expires_at": "string",
"id": "string",
"name": "string",
"thumbprint_sha256": "string",
"updated_at": "string",
}],
},
signed_request_object={
"credentials": [{
"credential_type": "string",
"pem": "string",
"algorithm": "string",
"created_at": "string",
"expires_at": "string",
"id": "string",
"key_id": "string",
"name": "string",
"parse_expiry_from_cert": False,
"updated_at": "string",
}],
"required": False,
},
tls_client_auth={
"credentials": [{
"credential_type": "string",
"created_at": "string",
"id": "string",
"name": "string",
"pem": "string",
"subject_dn": "string",
"updated_at": "string",
}],
})
const clientCredentialsResource = new auth0.ClientCredentials("clientCredentialsResource", {
clientId: "string",
authenticationMethod: "string",
clientSecret: "string",
privateKeyJwt: {
credentials: [{
credentialType: "string",
pem: "string",
algorithm: "string",
createdAt: "string",
expiresAt: "string",
id: "string",
keyId: "string",
name: "string",
parseExpiryFromCert: false,
updatedAt: "string",
}],
},
selfSignedTlsClientAuth: {
credentials: [{
pem: "string",
createdAt: "string",
credentialType: "string",
expiresAt: "string",
id: "string",
name: "string",
thumbprintSha256: "string",
updatedAt: "string",
}],
},
signedRequestObject: {
credentials: [{
credentialType: "string",
pem: "string",
algorithm: "string",
createdAt: "string",
expiresAt: "string",
id: "string",
keyId: "string",
name: "string",
parseExpiryFromCert: false,
updatedAt: "string",
}],
required: false,
},
tlsClientAuth: {
credentials: [{
credentialType: "string",
createdAt: "string",
id: "string",
name: "string",
pem: "string",
subjectDn: "string",
updatedAt: "string",
}],
},
});
type: auth0:ClientCredentials
properties:
authenticationMethod: string
clientId: string
clientSecret: string
privateKeyJwt:
credentials:
- algorithm: string
createdAt: string
credentialType: string
expiresAt: string
id: string
keyId: string
name: string
parseExpiryFromCert: false
pem: string
updatedAt: string
selfSignedTlsClientAuth:
credentials:
- createdAt: string
credentialType: string
expiresAt: string
id: string
name: string
pem: string
thumbprintSha256: string
updatedAt: string
signedRequestObject:
credentials:
- algorithm: string
createdAt: string
credentialType: string
expiresAt: string
id: string
keyId: string
name: string
parseExpiryFromCert: false
pem: string
updatedAt: string
required: false
tlsClientAuth:
credentials:
- createdAt: string
credentialType: string
id: string
name: string
pem: string
subjectDn: string
updatedAt: string
ClientCredentials Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ClientCredentials resource accepts the following input properties:
- Client
Id string - The ID of the client for which to configure the authentication method.
- Authentication
Method string - Configure the method to use when making requests to any endpoint that requires this client to authenticate. Options include
none
(public client without a client secret),client_secret_post
(confidential client using HTTP POST parameters),client_secret_basic
(confidential client using HTTP Basic),private_key_jwt
(confidential client using a Private Key JWT),tls_client_auth
(confidential client using CA-based mTLS authentication),self_signed_tls_client_auth
(confidential client using mTLS authentication utilizing a self-signed certificate). - Client
Secret string - Private
Key ClientJwt Credentials Private Key Jwt - Defines
private_key_jwt
client authentication method. - Self
Signed ClientTls Client Auth Credentials Self Signed Tls Client Auth - Defines
tls_client_auth
client authentication method. - Signed
Request ClientObject Credentials Signed Request Object - Configuration for JWT-secured Authorization Requests(JAR).
- Tls
Client ClientAuth Credentials Tls Client Auth - Defines
tls_client_auth
client authentication method.
- Client
Id string - The ID of the client for which to configure the authentication method.
- Authentication
Method string - Configure the method to use when making requests to any endpoint that requires this client to authenticate. Options include
none
(public client without a client secret),client_secret_post
(confidential client using HTTP POST parameters),client_secret_basic
(confidential client using HTTP Basic),private_key_jwt
(confidential client using a Private Key JWT),tls_client_auth
(confidential client using CA-based mTLS authentication),self_signed_tls_client_auth
(confidential client using mTLS authentication utilizing a self-signed certificate). - Client
Secret string - Private
Key ClientJwt Credentials Private Key Jwt Args - Defines
private_key_jwt
client authentication method. - Self
Signed ClientTls Client Auth Credentials Self Signed Tls Client Auth Args - Defines
tls_client_auth
client authentication method. - Signed
Request ClientObject Credentials Signed Request Object Args - Configuration for JWT-secured Authorization Requests(JAR).
- Tls
Client ClientAuth Credentials Tls Client Auth Args - Defines
tls_client_auth
client authentication method.
- client
Id String - The ID of the client for which to configure the authentication method.
- authentication
Method String - Configure the method to use when making requests to any endpoint that requires this client to authenticate. Options include
none
(public client without a client secret),client_secret_post
(confidential client using HTTP POST parameters),client_secret_basic
(confidential client using HTTP Basic),private_key_jwt
(confidential client using a Private Key JWT),tls_client_auth
(confidential client using CA-based mTLS authentication),self_signed_tls_client_auth
(confidential client using mTLS authentication utilizing a self-signed certificate). - client
Secret String - private
Key ClientJwt Credentials Private Key Jwt - Defines
private_key_jwt
client authentication method. - self
Signed ClientTls Client Auth Credentials Self Signed Tls Client Auth - Defines
tls_client_auth
client authentication method. - signed
Request ClientObject Credentials Signed Request Object - Configuration for JWT-secured Authorization Requests(JAR).
- tls
Client ClientAuth Credentials Tls Client Auth - Defines
tls_client_auth
client authentication method.
- client
Id string - The ID of the client for which to configure the authentication method.
- authentication
Method string - Configure the method to use when making requests to any endpoint that requires this client to authenticate. Options include
none
(public client without a client secret),client_secret_post
(confidential client using HTTP POST parameters),client_secret_basic
(confidential client using HTTP Basic),private_key_jwt
(confidential client using a Private Key JWT),tls_client_auth
(confidential client using CA-based mTLS authentication),self_signed_tls_client_auth
(confidential client using mTLS authentication utilizing a self-signed certificate). - client
Secret string - private
Key ClientJwt Credentials Private Key Jwt - Defines
private_key_jwt
client authentication method. - self
Signed ClientTls Client Auth Credentials Self Signed Tls Client Auth - Defines
tls_client_auth
client authentication method. - signed
Request ClientObject Credentials Signed Request Object - Configuration for JWT-secured Authorization Requests(JAR).
- tls
Client ClientAuth Credentials Tls Client Auth - Defines
tls_client_auth
client authentication method.
- client_
id str - The ID of the client for which to configure the authentication method.
- authentication_
method str - Configure the method to use when making requests to any endpoint that requires this client to authenticate. Options include
none
(public client without a client secret),client_secret_post
(confidential client using HTTP POST parameters),client_secret_basic
(confidential client using HTTP Basic),private_key_jwt
(confidential client using a Private Key JWT),tls_client_auth
(confidential client using CA-based mTLS authentication),self_signed_tls_client_auth
(confidential client using mTLS authentication utilizing a self-signed certificate). - client_
secret str - private_
key_ Clientjwt Credentials Private Key Jwt Args - Defines
private_key_jwt
client authentication method. - self_
signed_ Clienttls_ client_ auth Credentials Self Signed Tls Client Auth Args - Defines
tls_client_auth
client authentication method. - signed_
request_ Clientobject Credentials Signed Request Object Args - Configuration for JWT-secured Authorization Requests(JAR).
- tls_
client_ Clientauth Credentials Tls Client Auth Args - Defines
tls_client_auth
client authentication method.
- client
Id String - The ID of the client for which to configure the authentication method.
- authentication
Method String - Configure the method to use when making requests to any endpoint that requires this client to authenticate. Options include
none
(public client without a client secret),client_secret_post
(confidential client using HTTP POST parameters),client_secret_basic
(confidential client using HTTP Basic),private_key_jwt
(confidential client using a Private Key JWT),tls_client_auth
(confidential client using CA-based mTLS authentication),self_signed_tls_client_auth
(confidential client using mTLS authentication utilizing a self-signed certificate). - client
Secret String - private
Key Property MapJwt - Defines
private_key_jwt
client authentication method. - self
Signed Property MapTls Client Auth - Defines
tls_client_auth
client authentication method. - signed
Request Property MapObject - Configuration for JWT-secured Authorization Requests(JAR).
- tls
Client Property MapAuth - Defines
tls_client_auth
client authentication method.
Outputs
All input properties are implicitly available as output properties. Additionally, the ClientCredentials resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing ClientCredentials Resource
Get an existing ClientCredentials 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?: ClientCredentialsState, opts?: CustomResourceOptions): ClientCredentials
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
authentication_method: Optional[str] = None,
client_id: Optional[str] = None,
client_secret: Optional[str] = None,
private_key_jwt: Optional[ClientCredentialsPrivateKeyJwtArgs] = None,
self_signed_tls_client_auth: Optional[ClientCredentialsSelfSignedTlsClientAuthArgs] = None,
signed_request_object: Optional[ClientCredentialsSignedRequestObjectArgs] = None,
tls_client_auth: Optional[ClientCredentialsTlsClientAuthArgs] = None) -> ClientCredentials
func GetClientCredentials(ctx *Context, name string, id IDInput, state *ClientCredentialsState, opts ...ResourceOption) (*ClientCredentials, error)
public static ClientCredentials Get(string name, Input<string> id, ClientCredentialsState? state, CustomResourceOptions? opts = null)
public static ClientCredentials get(String name, Output<String> id, ClientCredentialsState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- 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.
- Authentication
Method string - Configure the method to use when making requests to any endpoint that requires this client to authenticate. Options include
none
(public client without a client secret),client_secret_post
(confidential client using HTTP POST parameters),client_secret_basic
(confidential client using HTTP Basic),private_key_jwt
(confidential client using a Private Key JWT),tls_client_auth
(confidential client using CA-based mTLS authentication),self_signed_tls_client_auth
(confidential client using mTLS authentication utilizing a self-signed certificate). - Client
Id string - The ID of the client for which to configure the authentication method.
- Client
Secret string - Private
Key ClientJwt Credentials Private Key Jwt - Defines
private_key_jwt
client authentication method. - Self
Signed ClientTls Client Auth Credentials Self Signed Tls Client Auth - Defines
tls_client_auth
client authentication method. - Signed
Request ClientObject Credentials Signed Request Object - Configuration for JWT-secured Authorization Requests(JAR).
- Tls
Client ClientAuth Credentials Tls Client Auth - Defines
tls_client_auth
client authentication method.
- Authentication
Method string - Configure the method to use when making requests to any endpoint that requires this client to authenticate. Options include
none
(public client without a client secret),client_secret_post
(confidential client using HTTP POST parameters),client_secret_basic
(confidential client using HTTP Basic),private_key_jwt
(confidential client using a Private Key JWT),tls_client_auth
(confidential client using CA-based mTLS authentication),self_signed_tls_client_auth
(confidential client using mTLS authentication utilizing a self-signed certificate). - Client
Id string - The ID of the client for which to configure the authentication method.
- Client
Secret string - Private
Key ClientJwt Credentials Private Key Jwt Args - Defines
private_key_jwt
client authentication method. - Self
Signed ClientTls Client Auth Credentials Self Signed Tls Client Auth Args - Defines
tls_client_auth
client authentication method. - Signed
Request ClientObject Credentials Signed Request Object Args - Configuration for JWT-secured Authorization Requests(JAR).
- Tls
Client ClientAuth Credentials Tls Client Auth Args - Defines
tls_client_auth
client authentication method.
- authentication
Method String - Configure the method to use when making requests to any endpoint that requires this client to authenticate. Options include
none
(public client without a client secret),client_secret_post
(confidential client using HTTP POST parameters),client_secret_basic
(confidential client using HTTP Basic),private_key_jwt
(confidential client using a Private Key JWT),tls_client_auth
(confidential client using CA-based mTLS authentication),self_signed_tls_client_auth
(confidential client using mTLS authentication utilizing a self-signed certificate). - client
Id String - The ID of the client for which to configure the authentication method.
- client
Secret String - private
Key ClientJwt Credentials Private Key Jwt - Defines
private_key_jwt
client authentication method. - self
Signed ClientTls Client Auth Credentials Self Signed Tls Client Auth - Defines
tls_client_auth
client authentication method. - signed
Request ClientObject Credentials Signed Request Object - Configuration for JWT-secured Authorization Requests(JAR).
- tls
Client ClientAuth Credentials Tls Client Auth - Defines
tls_client_auth
client authentication method.
- authentication
Method string - Configure the method to use when making requests to any endpoint that requires this client to authenticate. Options include
none
(public client without a client secret),client_secret_post
(confidential client using HTTP POST parameters),client_secret_basic
(confidential client using HTTP Basic),private_key_jwt
(confidential client using a Private Key JWT),tls_client_auth
(confidential client using CA-based mTLS authentication),self_signed_tls_client_auth
(confidential client using mTLS authentication utilizing a self-signed certificate). - client
Id string - The ID of the client for which to configure the authentication method.
- client
Secret string - private
Key ClientJwt Credentials Private Key Jwt - Defines
private_key_jwt
client authentication method. - self
Signed ClientTls Client Auth Credentials Self Signed Tls Client Auth - Defines
tls_client_auth
client authentication method. - signed
Request ClientObject Credentials Signed Request Object - Configuration for JWT-secured Authorization Requests(JAR).
- tls
Client ClientAuth Credentials Tls Client Auth - Defines
tls_client_auth
client authentication method.
- authentication_
method str - Configure the method to use when making requests to any endpoint that requires this client to authenticate. Options include
none
(public client without a client secret),client_secret_post
(confidential client using HTTP POST parameters),client_secret_basic
(confidential client using HTTP Basic),private_key_jwt
(confidential client using a Private Key JWT),tls_client_auth
(confidential client using CA-based mTLS authentication),self_signed_tls_client_auth
(confidential client using mTLS authentication utilizing a self-signed certificate). - client_
id str - The ID of the client for which to configure the authentication method.
- client_
secret str - private_
key_ Clientjwt Credentials Private Key Jwt Args - Defines
private_key_jwt
client authentication method. - self_
signed_ Clienttls_ client_ auth Credentials Self Signed Tls Client Auth Args - Defines
tls_client_auth
client authentication method. - signed_
request_ Clientobject Credentials Signed Request Object Args - Configuration for JWT-secured Authorization Requests(JAR).
- tls_
client_ Clientauth Credentials Tls Client Auth Args - Defines
tls_client_auth
client authentication method.
- authentication
Method String - Configure the method to use when making requests to any endpoint that requires this client to authenticate. Options include
none
(public client without a client secret),client_secret_post
(confidential client using HTTP POST parameters),client_secret_basic
(confidential client using HTTP Basic),private_key_jwt
(confidential client using a Private Key JWT),tls_client_auth
(confidential client using CA-based mTLS authentication),self_signed_tls_client_auth
(confidential client using mTLS authentication utilizing a self-signed certificate). - client
Id String - The ID of the client for which to configure the authentication method.
- client
Secret String - private
Key Property MapJwt - Defines
private_key_jwt
client authentication method. - self
Signed Property MapTls Client Auth - Defines
tls_client_auth
client authentication method. - signed
Request Property MapObject - Configuration for JWT-secured Authorization Requests(JAR).
- tls
Client Property MapAuth - Defines
tls_client_auth
client authentication method.
Supporting Types
ClientCredentialsPrivateKeyJwt, ClientCredentialsPrivateKeyJwtArgs
- Credentials
List<Client
Credentials Private Key Jwt Credential> - Client credentials available for use when Private Key JWT is in use as the client authentication method. A maximum of 2 client credentials can be set.
- Credentials
[]Client
Credentials Private Key Jwt Credential - Client credentials available for use when Private Key JWT is in use as the client authentication method. A maximum of 2 client credentials can be set.
- credentials
List<Client
Credentials Private Key Jwt Credential> - Client credentials available for use when Private Key JWT is in use as the client authentication method. A maximum of 2 client credentials can be set.
- credentials
Client
Credentials Private Key Jwt Credential[] - Client credentials available for use when Private Key JWT is in use as the client authentication method. A maximum of 2 client credentials can be set.
- credentials
Sequence[Client
Credentials Private Key Jwt Credential] - Client credentials available for use when Private Key JWT is in use as the client authentication method. A maximum of 2 client credentials can be set.
- credentials List<Property Map>
- Client credentials available for use when Private Key JWT is in use as the client authentication method. A maximum of 2 client credentials can be set.
ClientCredentialsPrivateKeyJwtCredential, ClientCredentialsPrivateKeyJwtCredentialArgs
- Credential
Type string - Credential type. Supported types:
public_key
. - Pem string
- PEM-formatted public key (SPKI and PKCS1) or X509 certificate. Must be JSON escaped.
- Algorithm string
- Algorithm which will be used with the credential. Can be one of
RS256
,RS384
,PS256
. If not specified,RS256
will be used. - Created
At string - The ISO 8601 formatted date the credential was created.
- Expires
At string - The ISO 8601 formatted date representing the expiration of the credential. It is not possible to set this to never expire after it has been set. Recreate the certificate if needed.
- Id string
- The ID of the client credential.
- Key
Id string - The key identifier of the credential, generated on creation.
- Name string
- Friendly name for a credential.
- Parse
Expiry boolFrom Cert - Parse expiry from x509 certificate. If true, attempts to parse the expiry date from the provided PEM. If also the
expires_at
is set the credential expiry will be set to the explicitexpires_at
value. - Updated
At string - The ISO 8601 formatted date the credential was updated.
- Credential
Type string - Credential type. Supported types:
public_key
. - Pem string
- PEM-formatted public key (SPKI and PKCS1) or X509 certificate. Must be JSON escaped.
- Algorithm string
- Algorithm which will be used with the credential. Can be one of
RS256
,RS384
,PS256
. If not specified,RS256
will be used. - Created
At string - The ISO 8601 formatted date the credential was created.
- Expires
At string - The ISO 8601 formatted date representing the expiration of the credential. It is not possible to set this to never expire after it has been set. Recreate the certificate if needed.
- Id string
- The ID of the client credential.
- Key
Id string - The key identifier of the credential, generated on creation.
- Name string
- Friendly name for a credential.
- Parse
Expiry boolFrom Cert - Parse expiry from x509 certificate. If true, attempts to parse the expiry date from the provided PEM. If also the
expires_at
is set the credential expiry will be set to the explicitexpires_at
value. - Updated
At string - The ISO 8601 formatted date the credential was updated.
- credential
Type String - Credential type. Supported types:
public_key
. - pem String
- PEM-formatted public key (SPKI and PKCS1) or X509 certificate. Must be JSON escaped.
- algorithm String
- Algorithm which will be used with the credential. Can be one of
RS256
,RS384
,PS256
. If not specified,RS256
will be used. - created
At String - The ISO 8601 formatted date the credential was created.
- expires
At String - The ISO 8601 formatted date representing the expiration of the credential. It is not possible to set this to never expire after it has been set. Recreate the certificate if needed.
- id String
- The ID of the client credential.
- key
Id String - The key identifier of the credential, generated on creation.
- name String
- Friendly name for a credential.
- parse
Expiry BooleanFrom Cert - Parse expiry from x509 certificate. If true, attempts to parse the expiry date from the provided PEM. If also the
expires_at
is set the credential expiry will be set to the explicitexpires_at
value. - updated
At String - The ISO 8601 formatted date the credential was updated.
- credential
Type string - Credential type. Supported types:
public_key
. - pem string
- PEM-formatted public key (SPKI and PKCS1) or X509 certificate. Must be JSON escaped.
- algorithm string
- Algorithm which will be used with the credential. Can be one of
RS256
,RS384
,PS256
. If not specified,RS256
will be used. - created
At string - The ISO 8601 formatted date the credential was created.
- expires
At string - The ISO 8601 formatted date representing the expiration of the credential. It is not possible to set this to never expire after it has been set. Recreate the certificate if needed.
- id string
- The ID of the client credential.
- key
Id string - The key identifier of the credential, generated on creation.
- name string
- Friendly name for a credential.
- parse
Expiry booleanFrom Cert - Parse expiry from x509 certificate. If true, attempts to parse the expiry date from the provided PEM. If also the
expires_at
is set the credential expiry will be set to the explicitexpires_at
value. - updated
At string - The ISO 8601 formatted date the credential was updated.
- credential_
type str - Credential type. Supported types:
public_key
. - pem str
- PEM-formatted public key (SPKI and PKCS1) or X509 certificate. Must be JSON escaped.
- algorithm str
- Algorithm which will be used with the credential. Can be one of
RS256
,RS384
,PS256
. If not specified,RS256
will be used. - created_
at str - The ISO 8601 formatted date the credential was created.
- expires_
at str - The ISO 8601 formatted date representing the expiration of the credential. It is not possible to set this to never expire after it has been set. Recreate the certificate if needed.
- id str
- The ID of the client credential.
- key_
id str - The key identifier of the credential, generated on creation.
- name str
- Friendly name for a credential.
- parse_
expiry_ boolfrom_ cert - Parse expiry from x509 certificate. If true, attempts to parse the expiry date from the provided PEM. If also the
expires_at
is set the credential expiry will be set to the explicitexpires_at
value. - updated_
at str - The ISO 8601 formatted date the credential was updated.
- credential
Type String - Credential type. Supported types:
public_key
. - pem String
- PEM-formatted public key (SPKI and PKCS1) or X509 certificate. Must be JSON escaped.
- algorithm String
- Algorithm which will be used with the credential. Can be one of
RS256
,RS384
,PS256
. If not specified,RS256
will be used. - created
At String - The ISO 8601 formatted date the credential was created.
- expires
At String - The ISO 8601 formatted date representing the expiration of the credential. It is not possible to set this to never expire after it has been set. Recreate the certificate if needed.
- id String
- The ID of the client credential.
- key
Id String - The key identifier of the credential, generated on creation.
- name String
- Friendly name for a credential.
- parse
Expiry BooleanFrom Cert - Parse expiry from x509 certificate. If true, attempts to parse the expiry date from the provided PEM. If also the
expires_at
is set the credential expiry will be set to the explicitexpires_at
value. - updated
At String - The ISO 8601 formatted date the credential was updated.
ClientCredentialsSelfSignedTlsClientAuth, ClientCredentialsSelfSignedTlsClientAuthArgs
- Credentials
List<Client
Credentials Self Signed Tls Client Auth Credential> - Credentials that will be enabled on the client for mTLS authentication utilizing self-signed certificates.
- Credentials
[]Client
Credentials Self Signed Tls Client Auth Credential - Credentials that will be enabled on the client for mTLS authentication utilizing self-signed certificates.
- credentials
List<Client
Credentials Self Signed Tls Client Auth Credential> - Credentials that will be enabled on the client for mTLS authentication utilizing self-signed certificates.
- credentials
Client
Credentials Self Signed Tls Client Auth Credential[] - Credentials that will be enabled on the client for mTLS authentication utilizing self-signed certificates.
- credentials
Sequence[Client
Credentials Self Signed Tls Client Auth Credential] - Credentials that will be enabled on the client for mTLS authentication utilizing self-signed certificates.
- credentials List<Property Map>
- Credentials that will be enabled on the client for mTLS authentication utilizing self-signed certificates.
ClientCredentialsSelfSignedTlsClientAuthCredential, ClientCredentialsSelfSignedTlsClientAuthCredentialArgs
- Pem string
- PEM-formatted X509 certificate. Must be JSON escaped.
- Created
At string - The ISO 8601 formatted date the credential was created.
- Credential
Type string - Credential type. Supported types:
x509_cert
. - Expires
At string - The ISO 8601 formatted date representing the expiration of the credential.
- Id string
- The ID of the client credential.
- Name string
- Friendly name for a credential.
- Thumbprint
Sha256 string - The X509 certificate's SHA256 thumbprint.
- Updated
At string - The ISO 8601 formatted date the credential was updated.
- Pem string
- PEM-formatted X509 certificate. Must be JSON escaped.
- Created
At string - The ISO 8601 formatted date the credential was created.
- Credential
Type string - Credential type. Supported types:
x509_cert
. - Expires
At string - The ISO 8601 formatted date representing the expiration of the credential.
- Id string
- The ID of the client credential.
- Name string
- Friendly name for a credential.
- Thumbprint
Sha256 string - The X509 certificate's SHA256 thumbprint.
- Updated
At string - The ISO 8601 formatted date the credential was updated.
- pem String
- PEM-formatted X509 certificate. Must be JSON escaped.
- created
At String - The ISO 8601 formatted date the credential was created.
- credential
Type String - Credential type. Supported types:
x509_cert
. - expires
At String - The ISO 8601 formatted date representing the expiration of the credential.
- id String
- The ID of the client credential.
- name String
- Friendly name for a credential.
- thumbprint
Sha256 String - The X509 certificate's SHA256 thumbprint.
- updated
At String - The ISO 8601 formatted date the credential was updated.
- pem string
- PEM-formatted X509 certificate. Must be JSON escaped.
- created
At string - The ISO 8601 formatted date the credential was created.
- credential
Type string - Credential type. Supported types:
x509_cert
. - expires
At string - The ISO 8601 formatted date representing the expiration of the credential.
- id string
- The ID of the client credential.
- name string
- Friendly name for a credential.
- thumbprint
Sha256 string - The X509 certificate's SHA256 thumbprint.
- updated
At string - The ISO 8601 formatted date the credential was updated.
- pem str
- PEM-formatted X509 certificate. Must be JSON escaped.
- created_
at str - The ISO 8601 formatted date the credential was created.
- credential_
type str - Credential type. Supported types:
x509_cert
. - expires_
at str - The ISO 8601 formatted date representing the expiration of the credential.
- id str
- The ID of the client credential.
- name str
- Friendly name for a credential.
- thumbprint_
sha256 str - The X509 certificate's SHA256 thumbprint.
- updated_
at str - The ISO 8601 formatted date the credential was updated.
- pem String
- PEM-formatted X509 certificate. Must be JSON escaped.
- created
At String - The ISO 8601 formatted date the credential was created.
- credential
Type String - Credential type. Supported types:
x509_cert
. - expires
At String - The ISO 8601 formatted date representing the expiration of the credential.
- id String
- The ID of the client credential.
- name String
- Friendly name for a credential.
- thumbprint
Sha256 String - The X509 certificate's SHA256 thumbprint.
- updated
At String - The ISO 8601 formatted date the credential was updated.
ClientCredentialsSignedRequestObject, ClientCredentialsSignedRequestObjectArgs
- Credentials
List<Client
Credentials Signed Request Object Credential> - Client credentials for use with JWT-secured authorization requests.
- Required bool
- Require JWT-secured authorization requests.
- Credentials
[]Client
Credentials Signed Request Object Credential - Client credentials for use with JWT-secured authorization requests.
- Required bool
- Require JWT-secured authorization requests.
- credentials
List<Client
Credentials Signed Request Object Credential> - Client credentials for use with JWT-secured authorization requests.
- required Boolean
- Require JWT-secured authorization requests.
- credentials
Client
Credentials Signed Request Object Credential[] - Client credentials for use with JWT-secured authorization requests.
- required boolean
- Require JWT-secured authorization requests.
- credentials
Sequence[Client
Credentials Signed Request Object Credential] - Client credentials for use with JWT-secured authorization requests.
- required bool
- Require JWT-secured authorization requests.
- credentials List<Property Map>
- Client credentials for use with JWT-secured authorization requests.
- required Boolean
- Require JWT-secured authorization requests.
ClientCredentialsSignedRequestObjectCredential, ClientCredentialsSignedRequestObjectCredentialArgs
- Credential
Type string - Credential type. Supported types:
public_key
. - Pem string
- PEM-formatted public key (SPKI and PKCS1) or X509 certificate. Must be JSON escaped.
- Algorithm string
- Algorithm which will be used with the credential. Can be one of
RS256
,RS384
,PS256
. If not specified,RS256
will be used. - Created
At string - The ISO 8601 formatted date the credential was created.
- Expires
At string - The ISO 8601 formatted date representing the expiration of the credential. It is not possible to set this to never expire after it has been set. Recreate the certificate if needed.
- Id string
- The ID of the client credential.
- Key
Id string - The key identifier of the credential, generated on creation.
- Name string
- Friendly name for a credential.
- Parse
Expiry boolFrom Cert - Parse expiry from x509 certificate. If true, attempts to parse the expiry date from the provided PEM. If also the
expires_at
is set the credential expiry will be set to the explicitexpires_at
value. - Updated
At string - The ISO 8601 formatted date the credential was updated.
- Credential
Type string - Credential type. Supported types:
public_key
. - Pem string
- PEM-formatted public key (SPKI and PKCS1) or X509 certificate. Must be JSON escaped.
- Algorithm string
- Algorithm which will be used with the credential. Can be one of
RS256
,RS384
,PS256
. If not specified,RS256
will be used. - Created
At string - The ISO 8601 formatted date the credential was created.
- Expires
At string - The ISO 8601 formatted date representing the expiration of the credential. It is not possible to set this to never expire after it has been set. Recreate the certificate if needed.
- Id string
- The ID of the client credential.
- Key
Id string - The key identifier of the credential, generated on creation.
- Name string
- Friendly name for a credential.
- Parse
Expiry boolFrom Cert - Parse expiry from x509 certificate. If true, attempts to parse the expiry date from the provided PEM. If also the
expires_at
is set the credential expiry will be set to the explicitexpires_at
value. - Updated
At string - The ISO 8601 formatted date the credential was updated.
- credential
Type String - Credential type. Supported types:
public_key
. - pem String
- PEM-formatted public key (SPKI and PKCS1) or X509 certificate. Must be JSON escaped.
- algorithm String
- Algorithm which will be used with the credential. Can be one of
RS256
,RS384
,PS256
. If not specified,RS256
will be used. - created
At String - The ISO 8601 formatted date the credential was created.
- expires
At String - The ISO 8601 formatted date representing the expiration of the credential. It is not possible to set this to never expire after it has been set. Recreate the certificate if needed.
- id String
- The ID of the client credential.
- key
Id String - The key identifier of the credential, generated on creation.
- name String
- Friendly name for a credential.
- parse
Expiry BooleanFrom Cert - Parse expiry from x509 certificate. If true, attempts to parse the expiry date from the provided PEM. If also the
expires_at
is set the credential expiry will be set to the explicitexpires_at
value. - updated
At String - The ISO 8601 formatted date the credential was updated.
- credential
Type string - Credential type. Supported types:
public_key
. - pem string
- PEM-formatted public key (SPKI and PKCS1) or X509 certificate. Must be JSON escaped.
- algorithm string
- Algorithm which will be used with the credential. Can be one of
RS256
,RS384
,PS256
. If not specified,RS256
will be used. - created
At string - The ISO 8601 formatted date the credential was created.
- expires
At string - The ISO 8601 formatted date representing the expiration of the credential. It is not possible to set this to never expire after it has been set. Recreate the certificate if needed.
- id string
- The ID of the client credential.
- key
Id string - The key identifier of the credential, generated on creation.
- name string
- Friendly name for a credential.
- parse
Expiry booleanFrom Cert - Parse expiry from x509 certificate. If true, attempts to parse the expiry date from the provided PEM. If also the
expires_at
is set the credential expiry will be set to the explicitexpires_at
value. - updated
At string - The ISO 8601 formatted date the credential was updated.
- credential_
type str - Credential type. Supported types:
public_key
. - pem str
- PEM-formatted public key (SPKI and PKCS1) or X509 certificate. Must be JSON escaped.
- algorithm str
- Algorithm which will be used with the credential. Can be one of
RS256
,RS384
,PS256
. If not specified,RS256
will be used. - created_
at str - The ISO 8601 formatted date the credential was created.
- expires_
at str - The ISO 8601 formatted date representing the expiration of the credential. It is not possible to set this to never expire after it has been set. Recreate the certificate if needed.
- id str
- The ID of the client credential.
- key_
id str - The key identifier of the credential, generated on creation.
- name str
- Friendly name for a credential.
- parse_
expiry_ boolfrom_ cert - Parse expiry from x509 certificate. If true, attempts to parse the expiry date from the provided PEM. If also the
expires_at
is set the credential expiry will be set to the explicitexpires_at
value. - updated_
at str - The ISO 8601 formatted date the credential was updated.
- credential
Type String - Credential type. Supported types:
public_key
. - pem String
- PEM-formatted public key (SPKI and PKCS1) or X509 certificate. Must be JSON escaped.
- algorithm String
- Algorithm which will be used with the credential. Can be one of
RS256
,RS384
,PS256
. If not specified,RS256
will be used. - created
At String - The ISO 8601 formatted date the credential was created.
- expires
At String - The ISO 8601 formatted date representing the expiration of the credential. It is not possible to set this to never expire after it has been set. Recreate the certificate if needed.
- id String
- The ID of the client credential.
- key
Id String - The key identifier of the credential, generated on creation.
- name String
- Friendly name for a credential.
- parse
Expiry BooleanFrom Cert - Parse expiry from x509 certificate. If true, attempts to parse the expiry date from the provided PEM. If also the
expires_at
is set the credential expiry will be set to the explicitexpires_at
value. - updated
At String - The ISO 8601 formatted date the credential was updated.
ClientCredentialsTlsClientAuth, ClientCredentialsTlsClientAuthArgs
- Credentials
List<Client
Credentials Tls Client Auth Credential> - Credentials that will be enabled on the client for CA-based mTLS authentication.
- Credentials
[]Client
Credentials Tls Client Auth Credential - Credentials that will be enabled on the client for CA-based mTLS authentication.
- credentials
List<Client
Credentials Tls Client Auth Credential> - Credentials that will be enabled on the client for CA-based mTLS authentication.
- credentials
Client
Credentials Tls Client Auth Credential[] - Credentials that will be enabled on the client for CA-based mTLS authentication.
- credentials
Sequence[Client
Credentials Tls Client Auth Credential] - Credentials that will be enabled on the client for CA-based mTLS authentication.
- credentials List<Property Map>
- Credentials that will be enabled on the client for CA-based mTLS authentication.
ClientCredentialsTlsClientAuthCredential, ClientCredentialsTlsClientAuthCredentialArgs
- Credential
Type string - Credential type. Supported types:
cert_subject_dn
. - Created
At string - The ISO 8601 formatted date the credential was created.
- Id string
- The ID of the client credential.
- Name string
- Friendly name for a credential.
- Pem string
- PEM-formatted X509 certificate. Must be JSON escaped. Mutually exlusive with
subject_dn
property. - Subject
Dn string - Subject Distinguished Name. Mutually exlusive with
pem
property. - Updated
At string - The ISO 8601 formatted date the credential was updated.
- Credential
Type string - Credential type. Supported types:
cert_subject_dn
. - Created
At string - The ISO 8601 formatted date the credential was created.
- Id string
- The ID of the client credential.
- Name string
- Friendly name for a credential.
- Pem string
- PEM-formatted X509 certificate. Must be JSON escaped. Mutually exlusive with
subject_dn
property. - Subject
Dn string - Subject Distinguished Name. Mutually exlusive with
pem
property. - Updated
At string - The ISO 8601 formatted date the credential was updated.
- credential
Type String - Credential type. Supported types:
cert_subject_dn
. - created
At String - The ISO 8601 formatted date the credential was created.
- id String
- The ID of the client credential.
- name String
- Friendly name for a credential.
- pem String
- PEM-formatted X509 certificate. Must be JSON escaped. Mutually exlusive with
subject_dn
property. - subject
Dn String - Subject Distinguished Name. Mutually exlusive with
pem
property. - updated
At String - The ISO 8601 formatted date the credential was updated.
- credential
Type string - Credential type. Supported types:
cert_subject_dn
. - created
At string - The ISO 8601 formatted date the credential was created.
- id string
- The ID of the client credential.
- name string
- Friendly name for a credential.
- pem string
- PEM-formatted X509 certificate. Must be JSON escaped. Mutually exlusive with
subject_dn
property. - subject
Dn string - Subject Distinguished Name. Mutually exlusive with
pem
property. - updated
At string - The ISO 8601 formatted date the credential was updated.
- credential_
type str - Credential type. Supported types:
cert_subject_dn
. - created_
at str - The ISO 8601 formatted date the credential was created.
- id str
- The ID of the client credential.
- name str
- Friendly name for a credential.
- pem str
- PEM-formatted X509 certificate. Must be JSON escaped. Mutually exlusive with
subject_dn
property. - subject_
dn str - Subject Distinguished Name. Mutually exlusive with
pem
property. - updated_
at str - The ISO 8601 formatted date the credential was updated.
- credential
Type String - Credential type. Supported types:
cert_subject_dn
. - created
At String - The ISO 8601 formatted date the credential was created.
- id String
- The ID of the client credential.
- name String
- Friendly name for a credential.
- pem String
- PEM-formatted X509 certificate. Must be JSON escaped. Mutually exlusive with
subject_dn
property. - subject
Dn String - Subject Distinguished Name. Mutually exlusive with
pem
property. - updated
At String - The ISO 8601 formatted date the credential was updated.
Import
This resource can be imported by specifying the client ID.
Example:
$ pulumi import auth0:index/clientCredentials:ClientCredentials my_creds "AaiyAPdpYdesoKnqjj8HJqRn4T5titww"
~> Importing this resource when the authentication_method
is set to private_key_jwt
will force the resource to be recreated.
This is to be expected, because the pem file can’t be checked for differences.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Auth0 pulumi/pulumi-auth0
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
auth0
Terraform Provider.