client_idis used to identify your client application. After you register a client application, you'll find the
client_idin the list of client applications in the workspace settings panel.
client_secretis generated in the client applications section of awork. It is located next to the
client_idon the workspace settings page. The secret will be used to authenticate your client application when you request a token.
offline_access: continued access, issues a refresh token.
Access Tokenis used to authenticate yourself within the API resources. It needs to be included in every request to the API. Each user has to use their own unique
Access Token, since such tokens are only valid with the associated user. Also, Access Tokens are valid for one workspace only. If the client application wants to access multiple workspaces, it needs to request separate tokens. The token is usually valid for only a few days.
Refresh Tokenis used to get a new
Access Tokenonce that one has expired. A
Refresh Tokenonly expires when the user manually revokes access for the client application.
Authorization Codeis a transitory code used to retrieve an
Access Token. It should not be stored in the client application.
Access Tokenand exchange a
Refresh Tokenfor a new
/accounts/authorizemay be used to initially retrieve an Authorization Code.
/accounts/tokenmay be used to retrieve an Access Token from either an Authorization Code or a Refresh Token.
application/x-www-form-urlencodedformat. The client directs the user to the constructed URI using a browser window. The user is prompted to log in, enter her or his username and password, and grant the requested permissions to the client application. If the user is part of several workspaces in awork, the user needs to select the workspace before authorizing the application.
client_id: The client Id of the client application - Required.
redirect_uri: The user will be redirected to a custom URI after the access was granted. Needs to be the same as specified when registering the client application - Required.
scope: A space-separated list of API scopes - Required.
state: An arbitrary state string that helps the client application to identify the request - Optional.
redirect_uri) may be properly URL-encoded.
redirect_uri: The previously specified redirect URI.
code: The authentication code that can be exchanged for a token later.
state: The same arbitrary state string that the client application passed in the authorization request earlier.
code: The code that was received in the previous authorization response. Required.
redirect_uri: The previously specified redirect URI. Required.
client_id: The client Id of the client application. Required.
client_secret: The client secret of the client application. Required.
redirect_uri) should be properly URL-encoded.