Users configuration
Available users can be configured in the users.yaml config file provided to ghostidp:
# This is an example config
users:
- username: jeandupont
display:
description: A demo user called Alice
email: jean.dupont@example.com
given_name: Jean
family_name: Dupont
custom_claims:
roles:
- admin
- user
department: engineering
employee_id: "12345"
Where the fiels are used as follows:
username: used in claimsdisplay.description: only used in the UIemail: used in claimsgiven_name: used in claimsfamily_name: used in claimscustom_claims: used in claims
As the name indicates, custom_claims can be used to provide custom claims per users to fit your application needs.
The standard claims are created as follows:
sub: mapped tousernameemail: mapped toemailgiven_name: mapped togiven_namefamily_name: mapped tofamily_namename:[given_name] [family_name]
The custom claims are then added to the standard claims. The claims resulting from the above example are thus:
sub:jeandupontemail:jean.dupont@example.comgiven_name:Jeanfamily_name:Dupontname:Jean Dupontroles:["admin", "user"]department:engineeringemployee_id:12345
As the name indicates, custom_claims can be used to provide custom claims per users to fit your application needs.