Bixby Developer Center

Guides
References

oauth2-custom

optionalvalue required

Enables you to specify a custom grant type that follows the standard OAuth flow.

The behavior of OAuth authorization using oauth2-custom depends on the presence of an authorize-endpoint:

  • If an authorize-endpoint is present, the flow will be the same flow as for the standard authorization_code flow. An authorization code will be requested from the authorize-endpoint and then used to request the access token from the token-endpoint. The specified grant-type will be used wherever relevant.
  • If an authorize-endpoint is not present, Bixby tries to directly request an access token from the given token-endpoint using the specified grant-type.

Child Keys

client-id
required
Public identifier for application requesting access
client-secret-key
required
Specifies the name of the secrets key, set in the Config & Secrets screen of the Bixby Developer Center, which stores the OAuth client secret
grant-type
required
Method used to acquire the access token
token-endpoint
required
The endpoint where the application exchanges the client credentials for an access token
authorize-endpoint
optional
The endpoint to call to request authorization, which is where the authorization server chooses whether or not to grant access
login-button-label
optional
Label used for the login button in an OAuth-based action
revoke-endpoint
optional
The endpoint that the application calls to revoke an access token
scope
optional
The scope of the OAuth request, which is used to limit access to data