Mozilla Change Integration Service: PersonAPI

March 26, 2018 ยท View on GitHub

This API return user profile data from the Change Integration Service dynamodb table.

For PersonAPI Users

API Locations

Scopes

  • read:email: access user's primaryEmail
  • read:profile: access all user profile data
  • No scope/public: access user's supported connections data (this is mainly used for the login window)

Endpoints

Access token

You will need to acquire an access token (also called bearer token) in order to access this API. The access token is valid for a limited amount of time and can be obtained by exchanging credentials with our OAuth2 API authorizer. The authorizer is not necessarily on the same domain as the API.

When the access token expire, it must be renewed in order to continue using the API.

Example:

curl --request POST -d
"client_id=XXX&client_secret=XXX&audience=https://person-api.sso.mozilla.com&grant_type=client_credentials"
https://auth.mozilla.auth0.com/oauth/token

See https://github.com/mozilla-iam/mozilla-iam/ for more information about how to obtain IAM credentials.

GET /v1/profile/{user_id}

Scope: read:profile

Returns the complete user profile

Example:

curl --request GET --url https://person-api.sso.allizom.org/v1/profile/ad%7CMozilla-LDAP-Dev%7Ckangtest --header 'authorization: Bearer YOURBEARERTOKENHERE'

Make sure you urlencode the user_id parameter.

GET /v1/connection/{email}

Returns the valid connections for the user (such as "ad", "github", etc.)

Scope: None

Example:

curl --request GET --url https://person-api.sso.allizom.org/v1/connection/gdestuynder@mozilla.com

For IAM Developers

Deployment How-to

docker run --rm -ti \
-v ~/.aws:/root/.aws \
-v ~/workspace/person-api/:/workspace \
mozillaiam/docker-sls:latest \
/bin/bash

npm install serverless-domain-manager --save-dev
npm install serverless-python-requirements --save-dev

API Endpoint Setup

API endpoints are setup in serverless.yml in the functions section.

Example:

...
functions:
  profilePublicConnectionMethod:
    # Calls `connection1.py`
    handler: connection1.handler
    events:
      - http:
          # Actual endpoint
          path: v1/connection/{email}
          method: get
...
          request:
            parameters:
              paths:
                email: true
...