• User (Resource Owner)
  • Endpoint
    • Parameters
  • Response
    • Status Codes (HTTP)

#User (Resource Owner)

SSOfy should be able to obtain user information in a variety of situations, such as in response to API queries like Resource Owner or Find User

We make an effort to maintain a limited level of compliance with OpenID Standards and start supporting all properties overtime.

#Endpoint

Consider the following specs in designing your client endpoint:

#Parameters

#Response

#Status Codes (HTTP)

When user information is requested after authorization is complete, SSOfy sends you the ids of session authorized scopes in the scopes parameter, allowing you to choose which properties to include in the response. If the email scope is missing, for example, you can exclude the email property from the response. Alternatively, if * is present, you can omit all other scopes and output all information.

Based on the schema, the only required properties in the response are id and hash. It would be nice though, if you could provide a display_name to make the user interface more verbose.

hash and id can both be the same. A typical use-case for hash is when the id included in the url for pages such as user profile differs. In this case, hash can be used instead of the real user id.

The response should be a json object containing the user data with the following structure:

{
    "id": "1",
    "hash": "1",
    "display_name": "Test User",
    "name": "Test",
    "picture": "https://...",
    "profile": "https://...",
    "username": "test",
    "email": "...",
    "email_verified": true,
    "phone": "+44...",
    "phone_verified": false,
    "given_name": null,
    "middle_name": null,
    "family_name": null,
    "nickname": null,
    "website": null,
    "gender": null,
    "birthdate": null,
    "address": null,
    "location": null,
    "zoneinfo": null,
    "locale": null,
    "custom_1": null,
    "custom_2": null,
    "custom_3": null,
    "custom_4": null,
    "custom_5": null,
    "custom_6": null,
    "custom_7": null,
    "custom_8": null,
    "custom_9": null,
    "additional": {}
}

If you need to incorporate additional data to be received and used in your other services, be sure to include it in the additional property.

SSOfy strictly verifies the structure of the response you generate, therefore having properties other than those defined in the schema is not allowed.