NetID
Follow these steps to add NetID as a social sign-in provider to your project using the Ory CLI:
Create a NetID Service and NetID Client.
In the created app, set the redirect URI to:
https://{project.slug}.projects.oryapis.com/self-service/methods/oidc/callback/netid
Create a Jsonnet code snippet to map the desired claims to the Ory Identity schema.
local claims = {
email_verified: false
} + std.extVar('claims');
{
identity: {
traits: {
// Allowing unverified email addresses enables account
// enumeration attacks, if the value is used for
// verification or as a password login identifier.
//
// Therefore we only return the email if it (a) exists and (b) is marked verified
// by NetID.
[if "email" in claims && claims.email_verified then "email" else null]: claims.email,
},
},
}infoNetID returns only the
sub
andsub_legacy
claims in theid_token
. Ory makes a request to NetID's /userinfo API and adds the user info tostd.extVar('claims')
.
Don't save secrets such as API keys, credentials, or personal data directly in Jsonnet code snippets. Jsonnet code snippets used for data mapping aren't stored in an encrypted format in The Ory Network.
Encode the Jsonnet snippet with Base64 or host it under an URL accessible to The Ory Network.
cat your-data-mapping.jsonnet | base64
Download the Ory Identities config from your project and save it to a file:
## List all available projects
ory list projects
## Get config
ory get identity-config {project-id} --format yaml > identity-config.yamlAdd the social sign-in provider configuration to the downloaded config. Add the Jsonnet snippet with mappings as a Base64 string or provide an URL to the file.
selfservice:
methods:
oidc:
config:
providers:
- id: netid # this is `<provider-id>` in the Authorization callback URL. DO NOT CHANGE IT ONCE SET!
provider: netid
client_id: .... # Replace this with the OAuth2 Client ID provided by NetID
client_secret: .... # Replace this with the OAuth2 Client Secret provided by NetID
mapper_url: "base64://{YOUR_BASE64_ENCODED_JSONNET_HERE}"
# Alternatively, use an URL:
# mapper_url: https://storage.googleapis.com/abc-cde-prd/9cac9717f007808bf17f22ce7f4295c739604b183f05ac4afb4t
requested_claims: # for more information navigate to https://developerzone.netid.dev/sso/#claims-and-scopes
userinfo:
email:
essential: true
email_verified:
essential: true
id_token:
email:
essential: true
email_verified:
essential: true
scope:
- email
- openid
enabled: trueUpdate the Ory Identities configuration using the file you worked with:
ory update identity-config {project-id} --file updated_config.yaml