• management
• Management
• PostClientCredentialRequestContent

Interface PostClientCredentialRequestContent

Example

{ * credential_type: "public_key" * }Copy

interface PostClientCredentialRequestContent {
credential_type: Management.ClientCredentialTypeEnum;
name?: string;
subject_dn?: string;
pem?: string;
alg?: Management.PublicKeyCredentialAlgorithmEnum;
parse_expiry_from_cert?: boolean;
expires_at?: string;
kid?: string;
}

Index

Properties

credential_typename?subject_dn?pem?alg?parse_expiry_from_cert?expires_at?kid?

Properties

credential_type

credential_type: Management.ClientCredentialTypeEnum

Optionalname

name?: string

Friendly name for a credential.

Optionalsubject_dn

subject_dn?: string

Subject Distinguished Name. Mutually exclusive with pem property. Applies to cert_subject_dn credential type.

Optionalpem

pem?: string

PEM-formatted public key (SPKI and PKCS1) or X509 certificate. Must be JSON escaped.

Optionalalg

alg?: Management.PublicKeyCredentialAlgorithmEnum

Optionalparse_expiry_from_cert

parse_expiry_from_cert?: boolean

Parse expiry from x509 certificate. If true, attempts to parse the expiry date from the provided PEM. Applies to public_key credential type.

Optionalexpires_at

expires_at?: string

The ISO 8601 formatted date representing the expiration of the credential. If not specified (not recommended), the credential never expires. Applies to public_key credential type.

Optionalkid

kid?: string

Optional kid (Key ID), used to uniquely identify the credential. If not specified, a kid value will be auto-generated. The kid header parameter in JWTs sent by your client should match this value. Valid format is [0-9a-zA-Z-_]{10,64}

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties credential_typenamesubject_dnpemalgparse_expiry_from_certexpires_atkid