Prerequisites
Ensure you have completed the end-to-end setup to log into your Tyk Dashboard via Okta. Refer to the official documentation for guidance:
OIDC with Okta
Step 1: Creating a Group
- Navigate to Groups in Okta.
- Create a new group named tyk-read-only.
- Assign a user to this group.
Step 2: Configuring Claims
- Go to Security > API in Okta.
- Click on the Authorization Servers tab.
- Select the appropriate Authorization Server (e.g., the default server).
- Navigate to the Claims section.
- Click Add Claim and configure it with the following details:
- Click Save.
Step 3: Verifying the Token
- Still within the Authorization Server settings, go to the Token Preview tab.
- Preview your token to ensure the claims are applied correctly.
Step 4: Configuring Tyk TIB
Below is an example of a working Tyk TIB configuration with group mapping:
- The CustomUserGroupField is mapped to the Okta claim
group-access
- The UserGroupMapping includes the Okta group tyk-read-only and its corresponding Tyk group ID.
"DefaultUserGroupID": "675b3495421aa91def668a51",
"CustomUserGroupField": "group-access",
"UserGroupMapping": {
"tyk-read-only": "675b3474421aa91def668a50"
},
"UserGroupSeparator": "",
"SSOOnlyForRegisteredUsers": false
}
Important Notes
- If SSO login is unable to detect the correct group, ensure that the DiscoverURL in the Tyk TIB profile points to the correct Authorization Server.
- The
openid
andemail
scopes must be included in the TIB profile for authentication to work correctly. Below is an example of a properly configuredUseProviders
section:
Comments
0 comments
Please sign in to leave a comment.