Skip to content

Commit 6e51879

Browse files
jlangyjlangy
committed
docs: update mappers
update mappers to table, add dc and bcsc
1 parent 540e00c commit 6e51879

File tree

3 files changed

+99
-3
lines changed

3 files changed

+99
-3
lines changed

‎wiki/Identity-Provider-Attribute-Mapping.md‎

Lines changed: 99 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,107 @@
1-
![IDP Mappers](./img/idp-mappers.jpg)
1+
See below for the IDP specific claims available. For all IDPs the **Keycloak Generated Preferred Username** will be a unique identifier with a reference to the idp, e.g. `<user-guid>@idp-alias`.
22

3-
![Github IDP Mappers](./img/gh-idp-mappers.jpg)
3+
## IDIR
4+
5+
| Description | Standard Realm - Claim Name |
6+
| ------------------------------------- | ----------------------------- |
7+
| First Name | given_name |
8+
| Last Name | family_name |
9+
| Email | email |
10+
| Display Name | display_name |
11+
| Display Name | name |
12+
| IDIR Username | idir_username |
13+
| IDIR User GUID | idir_user_guid |
14+
| Keycloak Generated Preferred Username | preferred_username |
415

516
* Any other attribute can be fetched by the app itself using [IDIM Web Services](https://sminfo.gov.bc.ca/)
617

18+
## IDIR MFA
19+
20+
| Description | Standard Realm - Claim Name |
21+
| ------------------------------------- | ----------------------------- |
22+
| First Name | given_name |
23+
| Last Name | family_name |
24+
| Email | email |
25+
| Email | user_principal_name |
26+
| Display Name | display_name |
27+
| Display Name | name |
28+
| IDIR Username | idir_username |
29+
| IDIR User GUID | idir_user_guid |
30+
| Keycloak Generated Preferred Username | preferred_username |
31+
32+
## Basic BCeID
33+
34+
| User Property/Attribute | Standard Realm - Claim Name |
35+
| ------------------------------------- | ----------------------------- |
36+
| Email | email |
37+
| Display Name | display_name |
38+
| Display Name | given_name |
39+
| Display Name | name |
40+
| BCeID Username | bceid_username |
41+
| BCeID User GUID | bceid_user_guid |
42+
| Keycloak Generated Preferred Username | preferred_username |
43+
44+
## Business BCeID
45+
46+
| User Property/Attribute | Standard Realm - Claim Name |
47+
| ------------------------------------- | ----------------------------- |
48+
| Email | email |
49+
| Display Name | display_name |
50+
| Display Name | given_name |
51+
| Display Name | name |
52+
| BCeID Username | bceid_username |
53+
| BCeID User GUID | bceid_user_guid |
54+
| Keycloak Generated Preferred Username | preferred_username |
55+
| BCeID Business Guid | bceid_business_guid |
56+
| BCeID Business Name | bceid_business_name |
57+
58+
## BCeID Both
59+
60+
See above for claims depending on BCeID type selected by end user.
61+
62+
## GitHub Public
63+
64+
| User Property/Attribute | Standard Realm - Claim Name |
65+
| ------------------------------------- | ---------------------------------------- |
66+
| Email | email |
67+
| Display Name | display_name |
68+
| Display Name | name |
69+
| Display Name | given_name |
70+
| GitHub ID | github_id |
71+
| Keycloak Generated Preferred Username | preferred_username=`{{id}}@githubpublic` |
72+
| GitHub Username | github_username |
73+
| BCGov Github Membership | org_verified |
74+
| BCGov Github Orgs | orgs |
75+
76+
## GitHub BCGov
77+
78+
| User Property/Attribute | Standard Realm - Claim Name |
79+
| ------------------------------------- | ---------------------------------------- |
80+
| Email | email |
81+
| Display Name | display_name |
82+
| Display Name | name |
83+
| Display Name | given_name |
84+
| GitHub ID | github_id |
85+
| Keycloak Generated Preferred Username | preferred_username |
86+
| GitHub Username | github_username |
87+
| BCGov Github Membership | org_verified |
88+
| BCGov Github Orgs | orgs |
89+
90+
## BC Services Card
91+
92+
| User Property/Attribute | Standard Realm - Claim Name |
93+
| ------------------------------------- | --------------------------------------- |
94+
| Keycloak Generated Preferred Username | preferred_username=`{{sub}}@<idp-name>` |
95+
96+
**Note:** Clients can request additional claims when creating their client in the CSS App. See [here](https://id.gov.bc.ca/oauth2/claim-types) for an up-to-date list of available claims. The BCSC sub will not be available for selection in the app, however the received token's sub or preferred_username claim can be used as an identifier.
97+
98+
## Digital Credential
799

8-
[Another way to view this from a developer perspective](https://bcgov.github.io/sso-docs/advanced/identity-mappers)
100+
| User Property/Attribute | Standard Realm - Claim Name |
101+
| ----------------------------------------- | ---------------------------------------------- |
102+
| Keycloak Generated Preferred Username | preferred_username |
103+
| Digital Credential Content (JSON) | vc_presented_attributes |
104+
| The Presentation Request Configuration ID | pres_req_conf_id |
9105

10106
## Playground
11107
[Try our playground to see what comes in the payload with your client integration](https://bcgov.github.io/keycloak-example-apps/)

‎wiki/img/gh-idp-mappers.jpg‎

-484 KB
Binary file not shown.

‎wiki/img/idp-mappers.jpg‎

-483 KB
Binary file not shown.

0 commit comments

Comments
 (0)