Generate admin token
Last updated
Last updated
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 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 on Add 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 the Available Roles
and click on Add 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
content-type*
String
Set to application/x-www-form-urlencoded
grant_type*
String
Set to password
client_id*
String
Set to registry-frontend
username*
String
The _osConfig.ownershipAttributes.userId
of the entity according to the schema
password*
String
Set to abcd@123
(default password, specified in registry's application.yml/docker compose file)
Important variables in the response body:
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
{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 on Add
button
Give a new client id and click on the save button
Update the access type
to confidential
.
Turn on Service Accounts Enabled
button.
And click on the save button
Goto Service Account Roles
tab
Select admin
role from the Available Roles
and click on Add selected
Goto Credentials
section and click on Regenerate 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
Content-Type*
String
application/x-www-form-urlencoded
grant_type*
client_credentials
client_id*
String
Use the client name that was used above
client_secret*
String
Use the client secret that was generated in the above steps
Add a Valid Redirect Url
Ex: