oauth_cimd
Creates, updates, deletes, gets or lists an oauth_cimd resource.
Overview​
| Name | oauth_cimd |
| Type | Resource |
| Id | sumologic.policies.oauth_cimd |
Fields​
The following fields are returned by SELECT queries:
- get
The OAuth policy for Client ID Metadata Documents (CIMD) authentication.
| Name | Datatype | Description |
|---|---|---|
o_auth_cimd_policy | string | OAuth CIMD policy. Valid values are: disabled, enabled, 'enabled-pre-registered-only' (pattern: <code>^(disabled|enabled|enabled-pre-registered-only)$</code>, example: disabled, x-pattern-message: must be one of the following: disabled, enabled, 'enabled-pre-registered-only') (wire: oAuthCimdPolicy) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | region | If disabled then authentication with Client ID Metadata Documents (CIMD) is disabled and no new CIMD clients can be created. If set to "enabled" then authentication with CIMD clients is enabled and new CIMD clients can be created automatically as part of authentication. If set to "enabled-pre-registered-only" then authentication with CIMD clients is enabled but new CIMD clients can only be created manually on the OAuth Clients page in the UI. | |
update | update | region, o_auth_cimd_policy | If disabled then authentication with Client ID Metadata Documents (CIMD) is disabled and no new CIMD clients can be created. If set to "enabled" then authentication with CIMD clients is enabled and new CIMD clients can be created automatically as part of authentication. If set to "enabled-pre-registered-only" then authentication with CIMD clients is enabled but new CIMD clients can only be created manually on the OAuth Clients page in the UI. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | Sumo Logic deployment (au, ca, ch, de, eu, fed, in, jp, kr, us1, us2). Resolved from the SUMOLOGIC_ENVIRONMENT environment variable when it is set (x-stackQL-envVar, the same variable the Terraform provider reads); otherwise defaults to us2. A WHERE region = '...' value always takes precedence. (enum: [au, ca, ch, de, eu, fed, in, jp, kr, us1, us2], default: us2, x-stackQL-envVar: SUMOLOGIC_ENVIRONMENT) |
SELECT examples​
- get
If disabled then authentication with Client ID Metadata Documents (CIMD) is disabled and no new CIMD clients can be created. If set to "enabled" then authentication with CIMD clients is enabled and new CIMD clients can be created automatically as part of authentication. If set to "enabled-pre-registered-only" then authentication with CIMD clients is enabled but new CIMD clients can only be created manually on the OAuth Clients page in the UI.
SELECT
o_auth_cimd_policy
FROM sumologic.policies.oauth_cimd
WHERE region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;
UPDATE examples​
- update
If disabled then authentication with Client ID Metadata Documents (CIMD) is disabled and no new CIMD clients can be created. If set to "enabled" then authentication with CIMD clients is enabled and new CIMD clients can be created automatically as part of authentication. If set to "enabled-pre-registered-only" then authentication with CIMD clients is enabled but new CIMD clients can only be created manually on the OAuth Clients page in the UI.
UPDATE sumologic.policies.oauth_cimd
SET
o_auth_cimd_policy = '{{ o_auth_cimd_policy }}'
WHERE
region = '{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set
AND o_auth_cimd_policy = '{{ o_auth_cimd_policy }}' --required
RETURNING
o_auth_cimd_policy;