Cozy OAuth clients doctype
io.cozy.oauth.clients
The io.cozy.oauth.clients
doctype contain the OAuth clients informations used in
the OAuth2 flow.
client_id
{string}: ClientID, part of the official OAuth Standardclient_secret
{string}: ClientSecret, part of the official OAuth Standard, generated by the cozy-stackclient_secret_expires_at
: {timestamp}: When the client secret will expire and will not be usable anymore. By default, it won’t expireregistration_access_token
{string}: Token used for the web instance onboardingallow_login_scope
{bool}: Allow (or not) a login scope generationredirect_uris
{[]string}: List of URIs used for redirection after login, declared by the client. Part of the official OAuth Standardgrant_types
{[]string}: Kind of grant for the client (authorization_code
orrefresh_token
). Part of the official OAuth Standardresponse_types
{[]string}: Kind of responses (code
). Part of the official OAuth Standardclient_name
{string}: Client nameclient_kind
{string}: Client kind (mobile, browser, desktop, …). Optional.client_uri
{string}: Client URI. Optional.logo_uri
{string}: Client logo URI. Optionalpolicy_uri
{string}: Client policy URI. Optionalsoftware_id
{string}: Client software identifiersoftware_version
{string}: Client software version. Optionalnotifications
{object}: Notifications parameters for the client.notifications_platform
{string}: Notification platform (android, iOS, …). Optional, declared by the clientnotifications_device_token
: {string}: Token for the notifications. Optional, declared by the client.client_os
: {string}: The Operating System of the client, inferred from the user-agent.synchronized_at
: {date}: Date of the last synchronization. Used by settings.last_refreshed_at
: {date}: Date of the last time an access_token has been given for this client (from an authorization_code or a refresh_token).onboarding_*
{string}:onboarding_secret
,onboarding_app
,onboarding_permissions
&onboarding_state
are used for an onboarding straight on the mobile.
The official documentation give a more in-depth overview of the OAuth client authorization workflow.