OAuth setup for Apple Messages for Business

  • Release version: Yokohama
  • Updated January 30, 2025
  • 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 to integrate your Identity Provider (IdP) with Apple Messages for Business using OAuth2 authentication and connect it to your ServiceNow® instance. The process involves configuring OAuth settings both in Apple Messages for Business and within ServiceNow to enable secure, authorized communication between the platforms.

    Show full answer Show less

    OAuth Configuration on Apple Messages for Business

    • Log in to your Apple Messages for Business account on the Apple Messages for Business site.
    • Navigate to the Integrated OAuth2 Authentication section.
    • Configure the following fields with information from your IdP:
      • OAuth URL: Authorization URL from your IdP
      • Token URL: Token URL from your IdP
      • Client Identifier: Client ID from your IdP
    • Refer to Apple’s official documentation for detailed OAuth2 setup instructions.

    OAuth Setup on ServiceNow® Instance

    • Create an Application Registry: Add a new record in the Application Registries (oauthentity) table using the Authorization Code grant type and include the Token URL from your IdP.
    • Define OAuth Scopes: Insert records in the OAuth Entity Scopes (oauthentityscope) table for each OAuth scope required, and create matching Entity Profile Scope records.
    • Establish Connection & Credential Aliases: Add a record in the Connection and Credential Aliases (sysalias) table to reference the HTTP connection.
    • Create HTTP(s) Connection: Add a record in the HTTP(s) Connection (httpconnection) table specifying:
      • Type: HTTP(s) Connection
      • Connection Alias: Link to the sysalias record
      • Connection URL: User information API endpoint from your IdP
    • Develop Profile Parser Action: Using Workflow Studio, create a profile parser to process user profile data from Apple Messages for Business. Code examples are provided in the documentation.
    • Configure Provider Application Authentication: Create a record in the Provider Application Authentications (syscsproviderappauthentication) table linking:
      • Provider Channel Identity to your provider app
      • OAuth Entity Profile to the OAuth entity record
      • Profile API Connection to the HTTP connection record
      • Profile Response Parser Action to the defined action type record

    Benefits for ServiceNow Customers

    Following this configuration enables secure, seamless OAuth2-based authentication between Apple Messages for Business and your ServiceNow instance. This integration streamlines identity verification and user profile management, enhancing communication workflows and ensuring compliance with OAuth standards.

    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.