Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DXCDT-248: Improve resource server RBAC docs #371

Merged
merged 1 commit into from
Oct 18, 2022
+10 −7
Merged

DXCDT-248: Improve resource server RBAC docs #371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/resources/resource_server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,14 @@ resource "auth0_resource_server" "my_resource_server" {
### Optional

- `allow_offline_access` (Boolean) Indicates whether refresh tokens can be issued for this resource server.
- `enforce_policies` (Boolean) Indicates whether authorization polices are enforced.
- `enforce_policies` (Boolean) If this setting is enabled, RBAC authorization policies will be enforced for this API. Role and permission assignments will be evaluated during the login transaction.
- `name` (String) Friendly name for the resource server. Cannot include `<` or `>` characters.
- `options` (Map of String) Used to store additional metadata.
- `scopes` (Block Set) List of permissions (scopes) used by this resource server. (see [below for nested schema](#nestedblock--scopes))
- `signing_alg` (String) Algorithm used to sign JWTs. Options include `HS256` and `RS256`.
- `signing_secret` (String) Secret used to sign tokens when using symmetric algorithms (HS256).
- `skip_consent_for_verifiable_first_party_clients` (Boolean) Indicates whether to skip user consent for applications flagged as first party.
- `token_dialect` (String) Dialect of access tokens that should be issued for this resource server. Options include `access_token` or `access_token_authz` (includes permissions).
- `token_dialect` (String) Dialect of access tokens that should be issued for this resource server. Options include `access_token` or `access_token_authz`. If this setting is set to `access_token_authz`, the Permissions claim will be added to the access token. Only available if RBAC (`enforce_policies`) is enabled for this API.
- `token_lifetime` (Number) Number of seconds during which access tokens issued for this resource server from the token endpoint remain valid.
- `token_lifetime_for_web` (Number) Number of seconds during which access tokens issued for this resource server via implicit or hybrid flows remain valid. Cannot be greater than the `token_lifetime` value.
- `verification_location` (String)
Expand Down
13 changes: 8 additions & 5 deletions internal/provider/resource_auth0_resource_server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,11 @@ func newResourceServer() *schema.Resource {
Description: "Used to store additional metadata.",
},
"enforce_policies": {
Type: schema.TypeBool,
Computed: true,
Optional: true,
Description: "Indicates whether authorization polices are enforced.",
Type: schema.TypeBool,
Computed: true,
Optional: true,
Description: "If this setting is enabled, RBAC authorization policies will be enforced for this API. " +
"Role and permission assignments will be evaluated during the login transaction.",
},
"token_dialect": {
Type: schema.TypeString,
Expand All @@ -132,7 +133,9 @@ func newResourceServer() *schema.Resource {
"access_token_authz",
}, true),
Description: "Dialect of access tokens that should be issued for this resource server. " +
"Options include `access_token` or `access_token_authz` (includes permissions).",
"Options include `access_token` or `access_token_authz`. " +
"If this setting is set to `access_token_authz`, the Permissions claim will be added to the access token. " +
"Only available if RBAC (`enforce_policies`) is enabled for this API.",
},
},
}
Expand Down