v1

latestOpenAPI 3.0.0Apache-2.02026-07-17326898.9 KB
oidc4ci

OIDC Register OAuth Client

Registers dynamically an OAuth 2.0 client with the VCS authorization server.

post/oidc/{profileID}/{profileVersion}/register

Request body

redirect_urisstring[]

Array of allowed redirection URI strings for the client. Required if client supports authorization_code grant type.

token_endpoint_auth_methodstring

Requested client authentication method for the token endpoint. Supported values: none, client_secret_post, client_secret_basic. None is used for public clients (native apps, mobile apps) which can not have secrets. Default: client_secret_basic.

grant_typesstring[]

Array of OAuth 2.0 grant types that the client is allowed to use. Supported values: authorization_code, urn:ietf:params:oauth:grant-type:pre-authorized_code.

response_typesstring[]

Array of OAuth 2.0 response types that the client can use at the authorization endpoint. Supported values: code.

scopestring

String containing a space-separated list of scope values that the client can use when requesting access tokens.

client_namestring

Human-readable string name of the client to be presented to the end-user during authorization.

client_uristring

URL string of a web page providing information about the client.

logo_uristring

URL string that references a logo for the client.

contactsstring[]

Array of strings representing ways to contact people responsible for this client, typically email addresses.

tos_uristring

URL string that points to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client.

policy_uristring

URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data.

jwks_uristring

URL string referencing the client's JSON Web Key (JWK) Set document, which contains the client's public keys.

jwksobject

Client's JSON Web Key Set document value, which contains the client's public keys.

software_idstring

A unique identifier string (e.g. UUID) assigned by the client developer or software publisher used by registration endpoints to identify the client software to be dynamically registered.

software_versionstring

A version identifier string for the client software identified by "software_id".

Response

Created

client_idstring required

Client identifier.

client_secretstring

Client secret. This value is used by the confidential client to authenticate to the token endpoint.

client_id_issued_atinteger required

Time at which the client identifier was issued.

client_secret_expires_atinteger

Time at which the client secret will expire or 0 if it will not expire.

redirect_urisstring[]

Array of allowed redirection URI strings for the client. Required if client supports authorization_code grant type.

token_endpoint_auth_methodstring required

Requested client authentication method for the token endpoint. Supported values: none, client_secret_post, client_secret_basic. None is used for public clients (native apps, mobile apps) which can not have secrets. Default: client_secret_basic.

grant_typesstring[] required

Array of OAuth 2.0 grant types that the client is allowed to use. Supported values: authorization_code, urn:ietf:params:oauth:grant-type:pre-authorized_code.

response_typesstring[]

Array of OAuth 2.0 response types that the client can use at the authorization endpoint. Supported values: code.

scopestring

String containing a space-separated list of scope values that the client can use when requesting access tokens.

client_namestring

Human-readable string name of the client to be presented to the end-user during authorization.

client_uristring

URL string of a web page providing information about the client.

logo_uristring

URL string that references a logo for the client.

contactsstring[]

Array of strings representing ways to contact people responsible for this client, typically email addresses.

tos_uristring

URL string that points to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client.

policy_uristring

URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data.

jwks_uristring

URL string referencing the client's JSON Web Key (JWK) Set document, which contains the client's public keys.

jwksobject

Client's JSON Web Key Set document value, which contains the client's public keys.

software_idstring

A unique identifier string (e.g. UUID) assigned by the client developer or software publisher used by registration endpoints to identify the client software to be dynamically registered.

software_versionstring

A version identifier string for the client software identified by "software_id".