15.1.1. REST API¶
This is the REST API for privacyidea. It lets you create the system configuration, which is denoted in the system endpoints.
Special system configuration is the configuration of
Resolvers are dynamic links to existing user sources. You can find users in LDAP directories, SQL databases, flat files or SCIM services. A resolver translates a loginname to a user object in the user source and back again. It is also responsible for fetching all additional needed information from the user source.
Realms are collections of resolvers that can be managed by administrators and where policies can be applied.
Defaultrealm is a special endpoint to define the default realm. The default realm is used if no user realm is specified. If a user from realm1 tries to authenticate or is addressed, the notation user@realm1 is used. If the @realm1 is omitted, the user is searched in the default realm.
Policies are rules how privacyidea behaves and which user and administrator is allowed to do what.
Start to read about authentication to the API at Authentication endpoints.
Now you can take a look at the several REST endpoints.
- 184.108.40.206. Audit endpoint
- 220.127.116.11. Authentication endpoints
- 18.104.22.168. Validate endpoints
- 22.214.171.124. System endpoints
- 126.96.36.199. Tokengroup endpoints
- 188.8.131.52. Service ID endpoints
- 184.108.40.206. Resolver endpoints
- 220.127.116.11. Realm endpoints
- 18.104.22.168. Default Realm endpoints
- 22.214.171.124. Token endpoints
- 126.96.36.199. User endpoints
- 188.8.131.52. Policy endpoints
- 184.108.40.206. Event endpoints
- 220.127.116.11. Machine Resolver endpoints
- 18.104.22.168. Machine endpoints
- 22.214.171.124. privacyIDEA Server endpoints
- 126.96.36.199. CA Connector endpoints
- 188.8.131.52. Recover endpoints
- 184.108.40.206. Register endpoints
- 220.127.116.11. Monitoring endpoints
- 18.104.22.168. Periodic Task endpoints
- 22.214.171.124. Application endpoints
- 126.96.36.199. Tokentype endpoints
- 188.8.131.52. SMTP server endpoints
- 184.108.40.206. SMS Gateway endpoints
- 220.127.116.11. RADIUS server endpoints
- 18.104.22.168. Subscriptions endpoints
- 22.214.171.124. Client endpoints