Sign in
OIDC Auth

Attach OIDC Auth configuration onto machine identity

post/api/v1/auth/oidc-auth/identities/{identityId}

Path parameters

identityIdstring required

The ID of the machine identity to attach the configuration onto.

Request body

templateIdstring uuid

The ID of the OIDC auth template to source identity provider settings from. When provided, the OIDC discovery URL, issuer, audiences, and CA certificate are taken from the template and cannot be set individually.

oidcDiscoveryUrlstring uri

The URL used to retrieve the OpenID Connect configuration from the identity provider.

caCertstring

The PEM-encoded CA cert for establishing secure communication with the Identity Provider endpoints.

boundIssuerstring

The unique identifier of the identity provider issuing the JWT.

boundAudiencesstring

The list of intended recipients.

boundClaimsobject required

The attributes that should be present in the JWT for it to be valid.

claimMetadataMappingobject

The attributes that should be present in the permission metadata from the JWT.

boundSubjectstring

The expected principal that is the subject of the JWT.

accessTokenTTLinteger

The lifetime for an access token in seconds.

accessTokenMaxTTLinteger

The maximum lifetime for an access token in seconds.

accessTokenNumUsesLimitinteger

The maximum number of times that an access token can be used.

Response

Default Response

Changes

Changed in 1 of the 23 revisions of this API.6

  • 57c08724c66e6See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      the request property became optional

      request-property-became-optional

    • ○

      the request property became optional

      request-property-became-optional

    • ○

      the request property default value was removed

      request-property-default-value-removed

    • ○

      the request property default value was removed

      request-property-default-value-removed

    • ○

      added the optional property / to the response with the status

      response-optional-property-added