API
Phase Two has built an API for managing custom functionality as extension to the standard Keycloak Admin REST API.
Base URI format
Paths specified in the documentation are relative to the the base URI.
- Format:
https://<host>:<port>/auth/realms
- Examples:
https://usw2.auth.ac/auth/realms
,https://euc1.auth.ac/auth/realms
API sections
📄️ Service Accounts
It is recommended to create one (or more) service accounts in order to call the Phase Two and Keycloak admin APIs. A service account can be thought of as a special type of user that is associated with each Client in Keycloak, but does not have user status in your application.
📄️ Authentication
Authentication is achieved by using the Authentication: Bearer header in all requests. This is either the access token received from a normal authentication, or by a request directly to the OpenID Connect token endpoint.
📄️ Software Development Kits
Much of the functionality described here is documented in our API section. Our API is built as extensions to the standard Keycloak Admin REST API, and can be used in a similar way.