OAuth setup for Apple Messages for Business

  • Release version: Xanadu
  • Updated August 1, 2024
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of OAuth setup for Apple Messages for Business

    This guide explains how ServiceNow customers can integrate Apple Messages for Business with their ServiceNow instance using OAuth2 authentication. The integration enables secure identity verification and user data exchange between Apple Messages for Business and ServiceNow through an Identity Provider (IdP).

    Show full answer Show less

    Connecting Apple Messages for Business to ServiceNow

    • Log in to your Apple Messages for Business account on the Apple Messages for Business portal.
    • Navigate to the Integrated OAuth2 Authentication section.
    • Configure OAuth2 settings by adding your IdP’s Authorization URL, Token URL, and Client ID into the respective fields.
    • Consult Apple’s documentation for detailed OAuth2 configuration on their platform.

    Setting up OAuth on Your ServiceNow Instance

    • Application Registry: Create a new record using a third-party OAuth provider with grant type set as Authorization Code and include the Token URL.
    • OAuth Entity Scopes: Define OAuth scopes required by your IdP. Add separate records for multiple scopes, each linked to an Entity Profile Scope.
    • Connection and Credential Aliases: Create a connection alias to reference the HTTP connection used for communication with the IdP.
    • HTTP(s) Connection: Create an HTTP(s) connection record pointing to your IdP’s user information API URL, using the connection alias created.
    • Profile Parser Action: Use Workflow Studio to build a profile parser action that processes user profile data returned by the IdP.
    • Provider Application Authentications: Link the OAuth Entity Profile, HTTP connection, and profile parser action to your Apple Messages for Business provider channel within ServiceNow.

    Practical Benefits

    Following this setup, ServiceNow customers can securely authenticate Apple Messages for Business users via their IdP and retrieve user profile information. This integration supports seamless communication and identity management workflows between Apple Messages for Business and ServiceNow.

    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.

    1. Go to the Apple Messages for Business page (register.apple.com) and log in to your Messages for Business account.
    2. Go to the Integrated OAuth2 Authentication section.
    3. Add the Authorization URL from your Identity Provider (IdP) to the OAuth URL field.
    4. Add the Token URL from your IdP to the Token URL field.
    5. Add the Client ID from your IdP to the Client Identifier field.
    6. 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

    1. Go to your ServiceNow® instance to set up OAuth.
    2. 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.
    3. 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.
    4. 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.
    5. 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)
    6. 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.
    7. 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.