OAuth setup for Apple Messages for Business
Summarize
Summary of OAuth setup for Apple Messages for Business
This guide explains how to integrate your Identity Provider (IdP) with Apple Messages for Business using OAuth2 authentication, enabling seamless connection between Apple Messages for Business and your ServiceNow® instance.
Show less
Connecting Apple Messages for Business to ServiceNow
- Log in to your Apple Messages for Business account on the Apple Messages for Business site.
- In the Integrated OAuth2 Authentication section, provide your IdP details:
- Authorization URL → OAuth URL field
- Token URL → Token URL field
- Client ID → Client Identifier field
- Refer to Apple’s documentation for detailed OAuth2 configuration.
Setting up OAuth in ServiceNow
- Create an Application Registry:
- Use a third-party OAuth provider.
- Select grant type "Authorization code".
- Enter the Token URL from your IdP.
- Define OAuth Entity Scopes:
- Create a record for each OAuth scope required.
- For multiple scopes, create corresponding Entity Profile Scope records.
- Create Connection and Credential Aliases:
- Set up an alias to reference the HTTP connection used for fetching user information.
- Configure HTTP(s) Connection:
- Create a connection record specifying the URL to your IdP’s user information API.
- Link it to the connection alias created earlier.
- Create a Profile Parser Action:
- Use Workflow Studio to create a parser action for Apple Messages for Business profile data.
- Refer to provided code snippets and documentation on building actions.
- Set Provider Application Authentication:
- Link to your provider app record.
- Associate with the OAuth Entity Profile and the HTTP connection record.
- Set the Profile Response Parser Action to the defined action type.
Key Outcomes
By following these steps, ServiceNow customers enable secure OAuth2 authentication between Apple Messages for Business and their ServiceNow instance. This integration allows authenticated user data retrieval from the IdP, facilitating streamlined identity management and messaging capabilities within ServiceNow workflows.
Integrate your Identity Provider (IdP) with Apple Messages for Business using OAuth2 authentication.
Connect Apple Messages for Business to your ServiceNow® instance
Complete the following steps on the Apple Messages for Business site to connect your Apple Messages for Business account to your ServiceNow® instance.
- Go to the Apple Messages for Business page (register.apple.com) and log in to your Messages for Business account.
- Go to the Integrated OAuth2 Authentication section.
- Add the Authorization URL from your Identity Provider (IdP) to the OAuth URL field.
- Add the Token URL from your IdP to the Token URL field.
- Add the Client ID from your IdP to the Client Identifier field.
- Refer to the Apple documentation for further instructions on configuring OAuth2 authentication on your Apple Messages for Business account.
Set up OAuth on your ServiceNow® instance
- Go to your ServiceNow® instance to set up OAuth.
- Create a new record in the Application
Registries (oauth_entity) table using these instructions: Use a third-party OAuth provider.
- Use the grant type Authorization code.
- Add the Token URL.
- Create a new record in the OAuth Entity Scopes (oauth_entity_scope) table using these instructions: Specify an OAuth scope. If you have multiple scopes, then add a new record for each scope, and create a corresponding Entity Profile Scope record for each scope.
- Create a new record in the Connection and Credential Aliases (sys_alias) table using these instructions: Create a Connection & Credential alias. This connection alias is used for fetching the http connection record which you create in the next step.
- Create a new record in the HTTP(s) Connection (http_connection) table using these instructions: Create an HTTP(s) connection.
- Type of connection - Select HTTP(s) Connection
Set the Connection alias to the sys_alias record created in previous step.
- Set the connection url to fetch the user information API as per your IdP. (For example: https://<your-idp-app>.com/api/v1/users)
- Create a Profile Parser Action using Workflow Studio. See the code snippets shown here for an example: Create a profile parser action for Apple Messages for Business. See Building actions for more details.
- Create a new record in the Provider Application Authentications (sys_cs_provider_app_authentication) table using these instructions:
- Set the Provider Channel Identity to your provider app (sys_cs_provider_application)
- Set the OAuth Entity Profile to the oauth_entity_profile record created with your OAuth Provider (oauth_entity) record.
Set the Profile API Connection to the http_connection record created previously.
- Set the Profile Response Parser Action to the sys_hub_action_type_definition record that you have defined.