Comment on page
Generate admin token
- Goto keycloak admin page, Ex: <domain>/auth/
- The default admin credentials will be (admin / admin). Update the default admin password for security reasons.
- Goto roles section and add a
admin
role if not present
You can create a new user or update the existing user with the above role. A client can also be used if you have a backend service that will call the registry APIs.
- Goto keycloak admin page, Ex: <domain>/auth/
- Goto
users
section and click onAdd user
button. - Fill in the required information and click on
Save
button - Goto
Credential
section and provide the password for the user - Once the user is created goto
Role Mappings
section - Select
admin
role from theAvailable Roles
and click onAdd selected
Use the below API to generate the token for the above user
To authenticate as an entity, we need to make the following request:
post
http:/keycloak-url/auth/realms/{realm}/protocol/openid-connect/token
Generate token API
Important variables in the response body:
Field | In | Type | Description |
---|---|---|---|
access_token | body | string | Access token used to retrieve/update entity |
expires_in | body | number | Number of seconds before the access token will be declared invalid |
token_type | body | string | Should be Bearer , else we have gotten the wrong token |
scope | body | string | Using this token, what information we can access about the entity |
curl --location \
--request POST \
--header 'content-type: application/x-www-form-urlencoded' \
--data 'client_id=registry-frontend' \
--data 'username={username}' \
--data 'password=test' \
--data 'grant_type=password' \
'{keycloak-url}/auth/realms/{realm}/protocol/openid-connect/token'
http --form post \
'{keycloak-url}/auth/realms/{realm}/protocol/openid-connect/token' \
'content-type: application/x-www-form-urlencoded' \
'client_id=registry-frontend' \
'username={username}' \
'password=test' \
'grant_type=password'
{keycloak-url}
is usually http://localhost:8080, and{realm}
is usuallysunbird-rc
.The{keycloak-url}
is usuallylocalhost:{port}
. The port can be found under thekeycloak
section in thedocker-compose.yml
file. The{realm}
can be found at the top of therealm-export.json
file used to configure keycloak.
- Goto keycloak admin page
- Goto
clients
section and click onAdd
button - Give a new client id and click on the save button
- Update the
access type
toconfidential
. - Turn on
Service Accounts Enabled
button. - And click on the save button
- Goto
Service Account Roles
tab - Select
admin
role from theAvailable Roles
and click onAdd selected
- Goto
Credentials
section and click onRegenerate secret
and copy the value
Use the below API to get the token for the above client created
post
http:/keycloak-url/auth/realms/{realm}/protocol/openid-connect/token
Generate token api
Last modified 7mo ago