OAuth setup for Apple Messages for Business

  • Release version: Washingtondc
  • Updated February 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 provides a step-by-step process for integrating your Identity Provider (IdP) with Apple Messages for Business using OAuth2 authentication, specifically for connecting it to your ServiceNow® instance.

    Show full answer Show less

    Key Features

    • Integration with Apple Messages for Business: Allows seamless connection between your ServiceNow instance and Apple Messages for Business.
    • OAuth2 Authentication: Utilizes secure authentication standards to ensure safe communication between platforms.
    • Multiple Configuration Points: Involves setting up various records in ServiceNow to facilitate the connection.

    Key Outcomes

    Upon completing the setup, you will have established a secure connection between your ServiceNow instance and Apple Messages for Business, enabling efficient management and communication through the platform.

    Setup Steps

    • On Apple Messages for Business Site:
      • Log in to your account and navigate to the Integrated OAuth2 Authentication section.
      • Input the Authorization URL, Token URL, and Client ID from your IdP into the respective fields.
      • Consult Apple documentation for additional configuration guidance.
    • On ServiceNow Instance:
      • Create a new record in the Application Registries table with the grant type set to Authorization code and include the Token URL.
      • Define OAuth scopes in the OAuth Entity Scopes table.
      • Set up a Connection & Credential alias in the Connection and Credential Aliases table.
      • Create an HTTP(s) connection and specify the user information API URL from your IdP.
      • Use Action Designer to create a Profile Parser Action for Apple Messages for Business.
      • Record authentication details in the Provider Application Authentications table, linking all previously created records.

    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 Action Designer. 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.