You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Data source to retrieve a specific Auth0 resource server by resource_server_id or identifier.
4
+
With this datasource, you can set up APIs that can be consumed from your authorized applications.
5
5
---
6
6
7
7
# Data Source: auth0_resource_server
8
8
9
-
Data source to retrieve a specific Auth0 resource server by `resource_server_id` or `identifier`.
9
+
With this datasource, you can set up APIs that can be consumed from your authorized applications.
10
10
11
11
## Example Usage
12
12
@@ -29,71 +29,68 @@ data "auth0_resource_server" "some-resource-server-by-id" {
29
29
30
30
-`identifier` (String) Unique identifier for the resource server. Used as the audience parameter for authorization calls. If not provided, `resource_server_id` must be set.
31
31
-`resource_server_id` (String) The ID of the resource server. If not provided, `identifier` must be set.
32
+
-`token_encryption` (Attributes) Configuration for JSON Web Encryption(JWE) of tokens for this resource server. (see [below for nested schema](#nestedatt--token_encryption))
32
33
33
34
### Read-Only
34
35
35
36
-`allow_offline_access` (Boolean) Indicates whether refresh tokens can be issued for this resource server.
36
-
-`authorization_details` (List of Object) Authorization details for this resource server. (see [below for nested schema](#nestedatt--authorization_details))
37
+
-`authorization_details` (Attributes List) Authorization details for this resource server. (see [below for nested schema](#nestedatt--authorization_details))
37
38
-`consent_policy` (String) Consent policy for this resource server. Options include `transactional-authorization-with-mfa`, or `null` to disable.
38
39
-`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.
39
-
-`id` (String) The ID of this resource.
40
-
-`name` (String) Friendly name for the resource server. Cannot include `<` or `>` characters.
41
-
-`proof_of_possession` (List of Object) Configuration settings for proof-of-possession for this resource server. (see [below for nested schema](#nestedatt--proof_of_possession))
42
-
-`scopes` (Set of Object) List of permissions (scopes) used by this resource server. (see [below for nested schema](#nestedatt--scopes))
40
+
-`name` (String) Friendly name for the resource server.
41
+
-`proof_of_possession` (Attributes) Configuration settings for proof-of-possession for this resource server. (see [below for nested schema](#nestedatt--proof_of_possession))
42
+
-`scopes` (Attributes Set) List of permissions (scopes) used by this resource server. (see [below for nested schema](#nestedatt--scopes))
43
43
-`signing_alg` (String) Algorithm used to sign JWTs. Options include `HS256`, `RS256`, and `PS256`.
44
44
-`signing_secret` (String) Secret used to sign tokens when using symmetric algorithms (HS256).
45
45
-`skip_consent_for_verifiable_first_party_clients` (Boolean) Indicates whether to skip user consent for applications flagged as first party.
46
46
-`token_dialect` (String) Dialect of access tokens that should be issued for this resource server. Options include `access_token`, `rfc9068_profile`, `access_token_authz`, and `rfc9068_profile_authz`. `access_token` is a JWT containing standard Auth0 claims. `rfc9068_profile` is a JWT conforming to the IETF JWT Access Token Profile. `access_token_authz` is a JWT containing standard Auth0 claims, including RBAC permissions claims. `rfc9068_profile_authz` is a JWT conforming to the IETF JWT Access Token Profile, including RBAC permissions claims. RBAC permissions claims are available if RBAC (`enforce_policies`) is enabled for this API. For more details, refer to [Access Token Profiles](https://auth0.com/docs/secure/tokens/access-tokens/access-token-profiles).
47
-
-`token_encryption` (List of Object) Configuration for JSON Web Encryption(JWE) of tokens for this resource server. (see [below for nested schema](#nestedatt--token_encryption))
48
47
-`token_lifetime` (Number) Number of seconds during which access tokens issued for this resource server from the token endpoint remain valid.
49
48
-`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.
50
49
-`verification_location` (String) URL from which to retrieve JWKs for this resource server. Used for verifying the JWT sent to Auth0 for token introspection.
51
50
52
-
<aid="nestedatt--authorization_details"></a>
53
-
### Nested Schema for `authorization_details`
51
+
<aid="nestedatt--token_encryption"></a>
52
+
### Nested Schema for `token_encryption`
54
53
55
54
Read-Only:
56
55
57
-
-`disable` (Boolean)
58
-
-`type` (String)
59
-
56
+
-`encryption_key` (Attributes) Authorization details for this resource server. (see [below for nested schema](#nestedatt--token_encryption--encryption_key))
57
+
-`format` (String) Format of the token encryption. Only `compact-nested-jwe` is supported.
-`customer_provided_root_key` (Block List, Max: 1) This attribute is used for provisioning the customer provided root key. To initiate the provisioning process, create a new empty `customer_provided_root_key` block. After applying this, the `public_wrapping_key` can be retreived from the resource, and the new root key should be generated by the customer and wrapped with the wrapping key, then base64-encoded and added as the `wrapped_key` attribute. (see [below for nested schema](#nestedblock--customer_provided_root_key))
53
+
-`customer_provided_root_key` (Block, Optional) This attribute is used for provisioning the customer provided root key. To initiate the provisioning process, create a new empty `customer_provided_root_key` block. After applying this, the `public_wrapping_key` can be retreived from the resource, and the new root key should be generated by the customer and wrapped with the wrapping key, then base64-encoded and added as the `wrapped_key` attribute. (see [below for nested schema](#nestedblock--customer_provided_root_key))
54
54
-`key_rotation_id` (String) If this value is changed, the encryption keys will be rotated. A UUID is recommended for the `key_rotation_id`.
55
55
56
56
### Read-Only
57
57
58
-
-`encryption_keys` (List of Object) All encryption keys. (see [below for nested schema](#nestedatt--encryption_keys))
59
-
-`id` (String) The ID of this resource.
58
+
-`encryption_keys` (Attributes List) All encryption keys. (see [below for nested schema](#nestedatt--encryption_keys))
Copy file name to clipboardExpand all lines: docs/resources/resource_server.md
+12-18Lines changed: 12 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -55,64 +55,58 @@ EOF
55
55
### Optional
56
56
57
57
-`allow_offline_access` (Boolean) Indicates whether refresh tokens can be issued for this resource server.
58
-
-`authorization_details` (Block List) Authorization details for this resource server. (see [below for nested schema](#nestedblock--authorization_details))
58
+
-`authorization_details` (Attributes List) Authorization details for this resource server. (see [below for nested schema](#nestedatt--authorization_details))
59
59
-`consent_policy` (String) Consent policy for this resource server. Options include `transactional-authorization-with-mfa`, or `null` to disable.
60
60
-`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.
61
61
-`name` (String) Friendly name for the resource server. Cannot include `<` or `>` characters.
62
-
-`proof_of_possession` (Block List, Max: 1) Configuration settings for proof-of-possession for this resource server. (see [below for nested schema](#nestedblock--proof_of_possession))
62
+
-`proof_of_possession` (Attributes) Configuration settings for proof-of-possession for this resource server. (see [below for nested schema](#nestedatt--proof_of_possession))
63
63
-`signing_alg` (String) Algorithm used to sign JWTs. Options include `HS256`, `RS256`, and `PS256`.
64
64
-`signing_secret` (String) Secret used to sign tokens when using symmetric algorithms (HS256).
65
65
-`skip_consent_for_verifiable_first_party_clients` (Boolean) Indicates whether to skip user consent for applications flagged as first party.
66
66
-`token_dialect` (String) Dialect of access tokens that should be issued for this resource server. Options include `access_token`, `rfc9068_profile`, `access_token_authz`, and `rfc9068_profile_authz`. `access_token` is a JWT containing standard Auth0 claims. `rfc9068_profile` is a JWT conforming to the IETF JWT Access Token Profile. `access_token_authz` is a JWT containing standard Auth0 claims, including RBAC permissions claims. `rfc9068_profile_authz` is a JWT conforming to the IETF JWT Access Token Profile, including RBAC permissions claims. RBAC permissions claims are available if RBAC (`enforce_policies`) is enabled for this API. For more details, refer to [Access Token Profiles](https://auth0.com/docs/secure/tokens/access-tokens/access-token-profiles).
67
-
-`token_encryption` (Block List, Max: 1) Configuration for JSON Web Encryption(JWE) of tokens for this resource server. (see [below for nested schema](#nestedblock--token_encryption))
67
+
-`token_encryption` (Attributes) Configuration for JSON Web Encryption(JWE) of tokens for this resource server. (see [below for nested schema](#nestedatt--token_encryption))
68
68
-`token_lifetime` (Number) Number of seconds during which access tokens issued for this resource server from the token endpoint remain valid.
69
69
-`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.
70
70
-`verification_location` (String) URL from which to retrieve JWKs for this resource server. Used for verifying the JWT sent to Auth0 for token introspection.
71
71
72
72
### Read-Only
73
73
74
-
-`id` (String) The ID of this resource.
74
+
-`resource_server_id` (String) A generated string identifying the resource server.
-`mechanism` (String) Mechanism used for proof-of-possession. Only `mtls` is supported.
92
90
-`required` (Boolean) Indicates whether proof-of-possession is required with this resource server.
93
91
94
92
95
-
<aid="nestedblock--token_encryption"></a>
93
+
<aid="nestedatt--token_encryption"></a>
96
94
### Nested Schema for `token_encryption`
97
95
98
96
Optional:
99
97
100
-
-`disable` (Boolean) Disable token encryption.
101
-
-`encryption_key` (Block List, Max: 1) Authorization details for this resource server. (see [below for nested schema](#nestedblock--token_encryption--encryption_key))
98
+
-`encryption_key` (Attributes) Authorization details for this resource server. (see [below for nested schema](#nestedatt--token_encryption--encryption_key))
102
99
-`format` (String) Format of the token encryption. Only `compact-nested-jwe` is supported.
0 commit comments