SSO - GDC OAuth to your application

Declare a new application

To use the GDC SSO, you have to create a new application in your profile settings, in "Vos applications". You have to set the name of your application, the URI of redirection and the information you want to get back in the response.

Be careful with the redirection, the URI has to be the same as the one you send in the request. For instance: https://myapp.io/connect/gdc

You can declare multiple redirection URIs, one per line.

The GDC SSO exposes 4 different scopes:

• profile => first_name, last_name, picture
• email => main email address
• groups => list of user public networks
• friends => list of user friend ids (referrerIds and refereeIds)

At the end of the application's registration, you get your secret application key in a confirmation message. Save it : you can't get it twice!

Configure your application with GDC SSO

In your application configuration, you have to use these informations to use SSO:

• Authorization URL: https://gensdeconfiance.com/oauth/v2/auth (used to login)
• Access token URL: https://gensdeconfiance.com/oauth/v2/token
• Information URL: https://gensdeconfiance.com/api/v2/members/me (used to get user information based on the selected scopes)

Use a specific user agent

Gens de Confiance monitors the partner API requests, to identify your requests in our monitoring tools please add the following User-Agent.

User-Agent: GdcApiClient (vanity:{{vanity}})

Where {{vanity}} corresponds to your Gens de Confiance member identifier found in your member page URL.

For example the value would be xxxxxxxx for a member page URL equals to https://gensdeconfiance.com/fr/m/xxxxxxxx.

If you do not use a valid User-Agent HTTP header in your requests your requests will still work but can be rate limited with more aggressive rates.

Process Response

References

FOSOAuthServerBundle

Example

Ask permission to user

Calling https://gensdeconfiance.com/oauth/v2/auth?client_id=YOUR_CLIENT_ID&response_type=code&redirect_uri=YOUR_REDIRECT_URI&scope=PERMISSION_ASKED will redirect the user to your callback url with a code parameter.

The scope parameter is a space separated values of permissions between: email, friends, groups and profile. For example: scope=email%20friends%20profile .

• Example:
  • https://gensdeconfiance.com/oauth/v2/auth?client_id=1_23ABCDE&response_type=code&redirect_uri=https%3A%2F%2Fmyapp.io%2Fconnect%2Fgdc&scope=email%20friends%20profile
  • Will redirect to:
    • https://myapp.io/connect/gdc?code=abcde1234

Retrieve the access_token

Using the code parameter on your callback endpoint, you can retrieve the access token calling the following URL:

• https://gensdeconfiance.com/oauth/v2/token?grant_type=authorization_code&redirect_uri=YOUR_REDIRECT_URI&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&code=THE_CODE_VALUE

The response will look like:

• if successful:

{
  "access_token": "some_access_token",
  "expires_in": 3600,
  "refresh_token": "some_refresh_token",
  "scope": null,
  "token_type": "bearer"
}

• if failed:

{
  "error": "invalid_grant",
  "error_description": "The authorization code has expired"
}

Get the user data

GET https://gensdeconfiance.com/api/v2/members/me with header AUTHORIZATION = Bearer ACCESS_TOKEN

Here is a sample response from the GDC api:

{
    "id": 12,
    "firstName": "sso-first_name",
    "lastName": "sso_last_name",
    "nbReferrers": 3,
    "gender": "male",
    "url": "https://gensdeconfiance.com/us/m/sso-user",
    "picture": "https://path-to-picture.com/sso-user.jpg",
    "email": "sso-user@example.org",
    "friendIds": [
      4,
      5,
      6
    ],
    "groups": [
      {
        "id": 3,
        "name": "sso-group",
        "image": "https://path-to-picture.com/sso-group.jpg"
      }
    ]
}

Refresh the user token

POST /oauth/v2/token
    client_id      <your-client-id>
    client_secret  <your-client-secret>
    refresh_token  <the-refresh-token>
    grant_type     refresh_token

Debugging

• If encoutered a 500 error, you should regenerate your user token in your application list: https://gensdeconfiance.com/us/m/me/applications