Sign in
latestSwagger 2.02026-08-0982147352.7 KB

be66ed178abe

Authentication Token

access token

Exchanges an auth_code for an access_token and refresh_token. An access_token is sent with every API call when using OAuth. When an access_token expires, the refresh_token is used to obtain a new access_token. So, securely store these tokens for later use. <br /><br /> The access_token should be included in the Authorization header as follows: Bearer {access_token} <br /><br /> Please see the <a href="/api/docs/v2#section/Authorization">AUTHORIZATION</a> section for a full explanation of the OAuth flow. <br /><br /> Also accepts `application/x-www-form-urlencoded'.

post/v{version}/connect/token

Path parameters

versionstring required

Request body

client_idstring required

Your Ease Application Id (that is, the Ease Application where, for example, the redirect uri and scopes are specified).

client_secretstring required

The 'secret' that was generated for your Ease Application. This secret is only visible directly after generat it, and is not otherwise retrievable.

redirect_uristring required

The redirect uri registered to your Application. This must exactly match the redirect uri set in the Ease Application.

codestring required
grant_typestring required

Supported grant_types are: authorization_code, and refresh_token.

refresh_tokenstring

Only required for grant_type = refresh_token. This refresh_token is part of the response when you submit an authorization code for a new access_token.

Response

OK

refresh_tokenstring required
granted_scopesstring required
access_tokenstring required

The access token usable for making API calls.

expires_ininteger required

The number of seconds before the token expires.

company_idstring

The company id that the token grants access to.

company_typestring

The type of company this is in Ease.

token_typestring required

The type of the token.

employee_idstring

The employee id that the token grants access to.