OAuth 2.0 Request

Updated on 05 Jun 2024
1 Minute to read
Contributors

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Overview

With the OAuth 2.0 protocol, you can verify your clients through your own or external services.

OAuth 2.0

OAuth

For more information on OAuth 2.0, go to the official documentation of Apple Messages for Business: Authentication Message.

Version 1.0

In the table below, you can see the ref token config that the user needs to add to the token storage.

Parameter	Type	Required	Description
oauth	object	+	Object with config oauth provider.
oauth.client_id	string	+	Client ID, is a public identifier for OAuth apps.
oauth.client_secret	string	+	The client secret, is a secret known only to the application and the authorization server.
oauth.scope	array of strings	+	Scope, is a mechanism in OAuth 2.0 to limit an application's access to a user's account.

Authentication Process Architecture v 1.0

Auth scheme.png

Version 2.0

In the table below, you can see the ref token config that the user needs to add to the token storage.

Parameter	Type	Required	Description
oauth	object	+	Object with config oauth provider.
oauth.client_id	string	+	Client ID, is a public identifier for OAuth apps.
oauth.client_secret	string	+	The client secret is a secret known only to the application and the authorization server.
oauth.redirect_uri	string	+	Redirect URL that the OAuth provider redirects the user.
oauth.scope	array of strings	+	Scope, is a mechanism in OAuth 2.0 to limit an application's access to a user's account.

The code and state values acquired on Redirect URL need to be sent to an OAuth receiver (./Messengers/Apple Business Chat/OAuth 2.0/OAuth 2.0 (receiver - v2)) using a direct URL in a POST request, or using the Sync API.

Authentication Process Architecture v 2.0

Was this article helpful?

What's Next

Components

Table of contents

Overview
Version 1.0
Version 2.0