clientApplications

Dynamically registers a new OAuth 2.0 client according to RFC 7591.

Changed on

<Check title="Required Permissions" icon="key">Allows unauthenticated access.</Check>

post/clientapplications/register

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/clientapplications/register
  • Auth: HTTP bearer

Request body

redirect_urisstring[] nullable
client_namestring nullable
token_endpoint_auth_methodstring nullable
grant_typesstring[] nullable
response_typesstring[] nullable
scopestring nullable
application_typestring nullable
contactsstring[] nullable
logo_uristring nullable
client_uristring nullable
policy_uristring nullable
tos_uristring nullable
software_idstring nullable
software_versionstring nullable

Response

Created

redirect_urisstring[] nullable

Array of redirection URI strings for use in redirect-based flows.

client_namestring nullable

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

token_endpoint_auth_methodstring nullable

Requested authentication method for the token endpoint.

grant_typesstring[] nullable

Array of OAuth 2.0 grant types that the client will use.

response_typesstring[] nullable

Array of OAuth 2.0 response types that the client will use.

scopestring nullable

Space-delimited list of OAuth 2.0 scope values.

application_typestring nullable

Kind of the application.

contactsstring[] nullable

Array of e-mail addresses of people responsible for this client.

logo_uristring nullable

URL that references a logo for the client application.

client_uristring nullable

URL of the home page of the client application.

policy_uristring nullable

URL that the client provides to the end-user with information about how the client uses their data.

tos_uristring nullable

URL that the client provides to the end-user to read about the client's terms of service.

software_idstring nullable

A unique identifier string (e.g., a Universally Unique Identifier (UUID)) assigned by the client developer.

software_versionstring nullable

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

client_idstring nullable

OAuth 2.0 client identifier string.

client_secretstring nullable

OAuth 2.0 client secret string. Only provided for confidential clients.

client_secret_expires_atinteger

Time at which the client secret will expire (0 if it doesn't expire).

client_id_issued_atinteger

Time at which the client identifier was issued as seconds since Unix epoch.

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PostClientApplicationsRegister removed and replaced with clientApplications_PostClientApplicationsRegister