Authentication

OAuth2 authentication endpoints for obtaining and refreshing access tokens

Get access token using client credentials

post

Authenticate using your OAuth2 client credentials to obtain an organization-level access token.

Authorizations

basicAuth

AuthorizationstringRequired

HTTP Basic authentication using OAuth2 client credentials (base64-encoded client_id:client_secret)

Responses

200

Access token issued successfully

application/json

OAuth2 access token response

access_tokenstringRequired

Access token for authenticating API requests. Use as Bearer token in the Authorization header.

Example: ct6Q2h1OiDHJaePbBgrpCgN3xfLPc9WYnCC6tRFd

token_typestring · enumRequired

Token type

Example: BearerPossible values:

expires_ininteger · int32Required

Token expiration time in seconds.

Example: 86400

refresh_tokenstring · nullableOptional

Refresh token for obtaining new access tokens.

Example: fx8TlqzAxg5b8Ukzp46rD-FXpxrNxHKX3BZQjGhG

400

Authentication failed

application/json

500

Internal server error

post

/oauth2/token?grant_type=client_credentials

HTTPcURLJavaScriptPython

POST /oauth2/token?grant_type=client_credentials HTTP/1.1
Host: blynk.cloud
Authorization: Basic username:password
Accept: */*

{
  "access_token": "ct6Q2h1OiDHJaePbBgrpCgN3xfLPc9WYnCC6tRFd",
  "token_type": "Bearer",
  "expires_in": 86400,
  "refresh_token": "fx8TlqzAxg5b8Ukzp46rD-FXpxrNxHKX3BZQjGhG"
}

Get access token using user credentials

post

Authenticate using OAuth2 client credentials along with the user's email and password to obtain a user-level access token. The user must belong to the same organization (or its child) as the OAuth2 client.

Authorizations

basicAuth

AuthorizationstringRequired

HTTP Basic authentication using OAuth2 client credentials (base64-encoded client_id:client_secret)

Body

application/json

userEmailstring · emailRequired

User email address

Example: [email protected]

passwordstring · passwordRequired

User password

Example: mySecretPassword123

Responses

200

Access token issued successfully

application/json

OAuth2 access token response

access_tokenstringRequired

Access token for authenticating API requests. Use as Bearer token in the Authorization header.

Example: ct6Q2h1OiDHJaePbBgrpCgN3xfLPc9WYnCC6tRFd

token_typestring · enumRequired

Token type

Example: BearerPossible values:

expires_ininteger · int32Required

Token expiration time in seconds.

Example: 86400

refresh_tokenstring · nullableOptional

Refresh token for obtaining new access tokens.

Example: fx8TlqzAxg5b8Ukzp46rD-FXpxrNxHKX3BZQjGhG

400

Authentication failed

application/json

500

Internal server error

post

/oauth2/token?grant_type=user_credentials

HTTPcURLJavaScriptPython

POST /oauth2/token?grant_type=user_credentials HTTP/1.1
Host: blynk.cloud
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "userEmail": "[email protected]",
  "password": "mySecretPassword123"
}

{
  "access_token": "ct6Q2h1OiDHJaePbBgrpCgN3xfLPc9WYnCC6tRFd",
  "token_type": "Bearer",
  "expires_in": 86400,
  "refresh_token": "fx8TlqzAxg5b8Ukzp46rD-FXpxrNxHKX3BZQjGhG"
}

Refresh an access token

post

Exchange a refresh token for a new access token. Each refresh token can only be used once — after use, the previous refresh token is invalidated and a new one is returned.

Authorizations

basicAuth

AuthorizationstringRequired

HTTP Basic authentication using OAuth2 client credentials (base64-encoded client_id:client_secret)

Query parameters

refresh_tokenstringRequired

The refresh token obtained from a previous token response

Responses

200

Access token refreshed successfully

application/json

OAuth2 access token response

access_tokenstringRequired

Access token for authenticating API requests. Use as Bearer token in the Authorization header.

Example: ct6Q2h1OiDHJaePbBgrpCgN3xfLPc9WYnCC6tRFd

token_typestring · enumRequired

Token type

Example: BearerPossible values:

expires_ininteger · int32Required

Token expiration time in seconds.

Example: 86400

refresh_tokenstring · nullableOptional

Refresh token for obtaining new access tokens.

Example: fx8TlqzAxg5b8Ukzp46rD-FXpxrNxHKX3BZQjGhG

400

Authentication failed

application/json

500

Internal server error

post

/oauth2/token?grant_type=refresh_token

HTTPcURLJavaScriptPython

POST /oauth2/token?grant_type=refresh_token?refresh_token=text HTTP/1.1
Host: blynk.cloud
Authorization: Basic username:password
Accept: */*

{
  "access_token": "ct6Q2h1OiDHJaePbBgrpCgN3xfLPc9WYnCC6tRFd",
  "token_type": "Bearer",
  "expires_in": 86400,
  "refresh_token": "fx8TlqzAxg5b8Ukzp46rD-FXpxrNxHKX3BZQjGhG"
}