Using the OAuth configuration in a Jigx solution

3min
1. Add a function to your 
﻿ solution to get a user’s profile information from Microsoft Graph. See the code below.
YAML
provider: DATA_PROVIDER_REST
method: GET
url: https://graph.microsoft.com/v1.0/me

parameters:
  accessToken:
    location: header
    required: true
    type: string
    value: microsoft.OAuth #Use manage.jigx.com to define credentials for your solution
provider: DATA_PROVIDER_REST
method: GET
url: https://graph.microsoft.com/v1.0/me

parameters:
  accessToken:
    location: header
    required: true
    type: string
    value: microsoft.OAuth #Use manage.jigx.com to define credentials for your solution
﻿
2. Add a jig that uses this function. 
To invoke the OAuth dialog, you must pass the accessToken parameter from the 
﻿ to the function. This is specific to when the REST provider is used with access tokens. If the access token parameter is not passed as part of the 
﻿ function configuration, the mobile app will not prompt the user for their credentials.
See the code below.
YAML
title: User Profile
description: Displays a user's profile information from Microsoft Graph API
type: jig.default

header:
  type: component.image
  options:
    source:
      uri: https://builder.jigx.com/assets/images/header.jpg

onFocus: 
  type: action.sync-entities
  options:
    provider: DATA_PROVIDER_REST
    entities:
      - entity: userProfile
        function: get-user-profile
        functionParameters:
          accessToken: microsoft.OAuth

datasources:
  mydata: 
    type: datasource.sqlite
    options:
      provider: DATA_PROVIDER_LOCAL
  
      entities:
        - entity: userProfile
  
      query: SELECT id, '$.displayName', '$.jobTitle', '$.userPrincipalName' FROM userProfile 
      
      isDocument: true

children:
  - type: component.entity
    options:
      children:
        - type: component.entity-field
          options:
            label: Display Name
            value: [email protected]
        - type: component.entity-field
          options:
            label: Job Title
            value: [email protected]
        - type: component.entity-field
          options:
            label: Principal Name
            value: [email protected]
title: User Profile
description: Displays a user's profile information from Microsoft Graph API
type: jig.default

header:
  type: component.image
  options:
    source:
      uri: https://builder.jigx.com/assets/images/header.jpg

onFocus: 
  type: action.sync-entities
  options:
    provider: DATA_PROVIDER_REST
    entities:
      - entity: userProfile
        function: get-user-profile
        functionParameters:
          accessToken: microsoft.OAuth

datasources:
  mydata: 
    type: datasource.sqlite
    options:
      provider: DATA_PROVIDER_LOCAL
  
      entities:
        - entity: userProfile
  
      query: SELECT id, '$.displayName', '$.jobTitle', '$.userPrincipalName' FROM userProfile 
      
      isDocument: true

children:
  - type: component.entity
    options:
      children:
        - type: component.entity-field
          options:
            label: Display Name
            value: =@ctx.datasources.mydata.displayName
        - type: component.entity-field
          options:
            label: Job Title
            value: =@ctx.datasources.mydata.jobTitle
        - type: component.entity-field
          options:
            label: Principal Name
            value: =@ctx.datasources.mydata.userPrincipalName
﻿
3. Add a 1x1 widget to access this 
﻿ in the index.jigx file. See the sample code below.
YAML
name: oauth-example
title: OAuth Example
category: miscellaneous
widgets:
  - size: 1x1 # choose size of the widget on the home hub
    jigId: view-user-profile

name: oauth-example
title: OAuth Example
category: miscellaneous
widgets:
  - size: 1x1 # choose size of the widget on the home hub
    jigId: view-user-profile
﻿
4. Publish the solution and open it in the 
﻿ Mobile app. The user should is prompted for their credentials. After a successful OAuth loop, the token will be stored for future use, and the function will be executed, displaying the information on the 
﻿.
OAuth loop
﻿
After a successful OAuth loop, the returned token will be stored for future use until it expires. If the provider supports a refresh token, 
﻿ will automatically use the refresh token to avoid prompting the user again for credentials. Once the refresh token becomes invalid or if no token was provided, 
﻿ will prompt the user with the OAuth loop to get a new token. 
If authentication fails, the user can use the Secondary Identities menu in the Settings section of the Jigx mobile App to manage OAuth tokens. If the token is not visible in the list, something failed early during the OAuth loop. Use the 
﻿ debug tools in 
﻿ to trace the error using the 
﻿ output window.
﻿
Updated 29 Apr 2024
Did this page help you?
Adding the OAuth Configuration to the solution in Jigx Management
Local REST Calls