External identity providers
This guide provides instructions on how to configure Aidbox to work with any IAM service that supports the OAuth 2.0 specification.
Additionally, we have created guides detailing the setup process for the most frequently requested IdP solutions. You may choose to utilize one of these guides, or you can browse down this page and explore that article.
| Aidbox | FHIR++ platform with built-in OAuth 2.0 | aidbox-logo.png | aidbox.md | |
| Okta | Enterprise-grade, ID management service | okta-logo.png | configure-okta.md | |
| Microsoft Azure AD | Cloud-based IAM service | azure-ad-logo.png | azure-ad.md | |
| Keycloak | Open-source IAM solution | keycloak-logo.png | keycloak.md |
IdentityProvider resource
To add external OAuth 2.0 Provider integration, you should create a resource called IdentityProvider. Aidbox uses it:
- to generate redirect links
- to make API calls to the provider
- to retrieve access token, user data etc.
All examples in this tutorial are executable in Aidbox REST Console
Create IdentityProvider
POST /IdentityProvider
Accept: text/yaml
Content-Type: text/yaml
resourceType: IdentityProvider
system: https://google.com
active: true
id: <provider-id>
userinfo-source: id-token | userinfo-endpoint
authorize_endpoint: https://accounts.google.com/o/oauth2/v2/auth
token_endpoint: https://www.googleapis.com/oauth2/v4/token
userinfo_endpoint: https://www.googleapis.com/oauth2/v1/userinfo
scopes:
- https://www.googleapis.com/auth/userinfo.profile
- https://www.googleapis.com/auth/userinfo.email
client:
id: <your auth client id>
secret: <your auth client secret>| attribute | description |
|---|---|
system | adds identifier for the created user with this system |
userinfo-source | If id-token, user.data is populated with the id_token.claims value. Otherwise request to the userinfo_endpoint is performed to get user details. |
authorize_endpoint | OAuth Provider authorization endpoint |
token_endpoint | OAuth Provider access token endpoint |
userinfo_endpoint | OAuth Provider user profile endpoint |
userinfo_header | Some providers require different prefix then "Bearer" for Authorization header in user info request. Fox example, if set to "OAuth" results in: GET /<userinfo_endpoint> with Authorization: Oauth <access token> |
scopes | array of scopes for which you request access from user |
client.id | id of the client you registered in OAuth Provider API |
client.secret | secret of the client you registered in OAuth Provider API |
Create Client resource
Next, we have to create a Client resource which receives access token from Aidbox backend later on and uses Aidbox API on behalf of the user. We enable the authorization_code flow for the application and provide the redirect_uri.
POST /Client
Accept: text/yaml
Content-Type: text/yaml
id: my-client
grant_types: ["authorization_code"]
first_party: true
auth:
authorization_code:
redirect_uri: <your app redirect uri>You should register /auth/callback/ as callback URI in your OAuth provider client application configuration.
Initiate the authorization
To initiate authorization, redirect the user to the endpoint /auth/redirect/. You should provide at least two query parameters client_id and response_type. The following API interactions happen as a result:
GET /auth/redirect/google?client_id=my-client&response_type=code
# your application entrypoint
# redirects to
GET https://accounts.google.com/o/oauth2/v2/auth?...
# user enters his credentials, allows aidbox access to his profile data
# provider redirects to
GET /auth/callback/google?...
# aidbox receives temporary token, exchanges it on access token by calling
GET https://www.googleapis.com/oauth2/v4/token?...
# using access token, aidbox calls user data endpoint
GET https://www.googleapis.com/oauth2/v1/userinfo
# then it creates User resource and continues with the flow specified
# in response_type query param
GET <your app redirect uri>?code=...Set-up additional mapping
By default, everything that is returned by provider's userinfo endpoint gets stored into User.data. You can also configure mapping to other User attributes by adding toScim object into IdentityProvider.
PUT /IdentityProvider/<provider-id>
Accept: text/yaml
Content-Type: text/yaml
toScim:
default_email:
- email
first_name:
- name
- givenName
last_name:
- name
- givenNameEach key here refers to the key in the userinfo response object, while value is an array that specifies path in a User resource.