API Role on Gravity

Reference

Mon, 01 Jan 0001 00:00:00 +0000

Permissions

Mon, 01 Jan 0001 00:00:00 +0000

Starting with Gravity 0.16, users can have permissions assigned to them. Permissions are assigned based on HTTP URL paths and methods. For example, to give a user permissions to read all resources, permissions can be set to this:

[
 {
 "path": "/*",
 "methods": ["get", "head"]
 }
]

To give users permissions to view DNS zones and records, you can set the permissions to

[
 {
 "path": "/api/v1/dns/zones",
 "methods": ["get"]
 },
 {
 "path": "/api/v1/dns/zones/records",
 "methods": ["get"]
 },
]

To give a user admin permissions, set the permissions to

Role configuration

Mon, 01 Jan 0001 00:00:00 +0000

port: The port the API server listens on (defaults to 8008).
oidc: Optional OpenID Connect config.
- clientID: OpenID Client Identifier.
- clientSecret: OpenID Client Secret.
- issuer: OpenID Issuer, sometimes also called “Configuration URL”. Ensure .well-known/openid-configuration suffix is removed.
- redirectURL: Redirect URL Gravity is reachable under. Should end in /auth/oidc/callback.
  
  The placeholder $INSTANCE_IDENTIFIER will be replaced by the instance’s name and $INSTANCE_IP will be replaced by the instances IP.
- scopes: Array of scopes that are requested. Should contain openid and email.