Authenticate OAuth

Description

 

Gets an OAuth 2.0 authentication token from an OAuth provider to be used to authenticate an HTTP request or a Socket Connection. This is often used to authenticate Web API's. This behaviour also securely saves your authenticated token to file which you can obtain using the Get OAuth Credentials behaviour.

 

Properties

Triggers on Completion

URL The base url of the OAuth provider. Eg. https://account.google.com
Endpoint The OAuth endpoint. Eg. /o/oauth2/v2/auth resulting in a final URL like: https://accounts.google.com/o/oauth/v2/auth
Client ID The client ID given by the OAuth provider.
Client Secret The secret key given by the OAuth provider.
Identifier Use this identifier to use with the Get OAuth Credentials behaviour after a successful authorization. This way you don't have to keep authenticating with the server every time you make a request. The credentials are securely stored for offline usage, so you can keep using the same identifier even after you quit the project and come back.
Grant Type The different OAuth authorization grant types. Available options are clientCredentials, password, authorizationCode, or refreshToken. Your OAuth provider should give you high level instructions of which grant type you need when.
Scope(clientCredentials, password, authorizationCode, refreshToken) Comma separated list of permissions you are allowed to use.

 

Outputs

Token Type

Outputs the type of token being accessed (this is known as 'the bearer').

Access Token

Outputs the authorization token to gain access from a server.

Refresh Token

Outputs a new access token for when the previous one expires.

Error

Outputs any errors that occur during authentication.

 

 

Examples 

Gain access to a web API that uses IAuth 2.0 for authentication.

 

Related

Connect to Socket

Emit to Socket

Get OAuth Credentials

Get Socket Status

HTTP Request

Open URL

Remove OAuth Credentials

Socket Event

Socket.io Client

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk