Authentication
Last updated
Last updated
Organization API uses OAuth authentication protocol in order to grant access and authenticate client requests. Your launch engineer has to provide you with an OAuth client identifier (clientId) and secret (clientSecret) at your request.
Alternatively, you can find it in Settings -> Developers -> OAuth2:
To obtain authentication tokens use client_credentials grant type as mentioned below:
POST https://{server_address}/oauth2/token
Authentication to Organization API using oAuth client credentials provided in Authorization header.
grant_type*
Use client_credentials
Authorization*
Provide authorization header with oAuth client credentials filled in basic authorization format:
Basic {credentials}
Example response:
Use access_token value to authenticate further requests and refresh_token to refresh the token after its expiration. Use expires_in (value specified in seconds) parameter to determine token expiration time.
cURL:
cURL with real data:
After authentication token expiration use refresh_token grant type to refresh it:
POST https://{server_address}/oauth2/token
Refreshing the authentication to Organization API using oAuth client credentials provided in Authorization header and refresh token issued in previous authentication response.
refresh_token*
Refresh token, issued by previous authentication request
grant_type*
refresh_token
Authorization*
Provide authorization header with oAuth client credentials filled in basic authorization format:
Basic {credentials}
Example response:
Use access_token value to authenticate further requests and refresh_token to refresh the token after it's expiration. Use expires_in (value specified in seconds) parameter to determine token expiration time.
cURL:
cURL with real data:
Authentication using query parameters is less preferred due to it's lower security, but more easier. You may use this authentication type to achieve quick results as it can even be tested in a browser.
POST https://{server_address}/oauth2/token
Authentication to Organization API using oAuth client credentials provided in query parameters.
grant_type*
client_credentials
client_id*
String
oAuth client identifier
client_secret*
String
oAuth client secret
Example response:
Use access_token value to authenticate further requests and refresh_token to refresh the token after it's expiration. Use expires_in (value specified in seconds) parameter to determine token expiration time.
cURL:
cURL with real data:
POST https://{server_address}/oauth2/token
Refreshing the authentication to Organization API using query parameters with oAuth client credentials and refresh token issued in previous authentication response.
grant_type*
refresh_token
refresh_token*
String
Refresh token, issued by previous authentication request
client_id*
String
oAuth client identifier
client_secret*
String
oAuth client secret
Example response:
Use access_token value to authenticate further requests and refresh_token to refresh the token after it's expiration. Use expires_in (value specified in seconds) parameter to determine token expiration time.
cURL:
cURL with real data:
