personal_access_keys
Creates, updates, deletes, gets or lists a personal_access_keys resource.
Overview​
| Name | personal_access_keys |
| Type | Resource |
| Id | sumologic.access_keys.personal_access_keys |
Fields​
The following fields are returned by SELECT queries:
- list
A list of all access keys that belong to the user making the request.
| Name | Datatype | Description |
|---|---|---|
id | string | Identifier of the access key. (example: su0w3Q37CBzHUM) |
service_account_id | string | Identifier of the service account who owns the access key. (example: 0000000006743FDA) (wire: serviceAccountId) |
cors_headers | array | An array of domains for which the access key is valid. Whether Sumo Logic accepts or rejects an API request depends on whether it contains an ORIGIN header and the entries in the allowlist. Sumo Logic will reject: 1. Requests with an ORIGIN header but the allowlist is empty. 2. Requests with an ORIGIN header that don't match any entry in the allowlist. (wire: corsHeaders) |
created_at | string (date-time) | Creation timestamp in UTC in [RFC3339](https:​//tools.ietf.org/html/rfc3339) format. (example: 2018-10-16T09:10:00.000Z) (wire: createdAt) |
created_by | string | Identifier of the user who created the access key. (example: 0000000006743FDD) (wire: createdBy) |
disabled | boolean | Indicates whether the access key is disabled or not. |
effective_scopes | array | Effective scopes based on the intersection of the user's RBAC capabilities and the assigned scopes. (wire: effectiveScopes) |
label | string | The name of the access key. (example: collector access key) |
last_used | string (date-time) | Last used timestamp in UTC. <br /> Note: Property not in use, it is part of an upcoming feature. (example: 2018-10-16T09:10:00.000Z) (wire: lastUsed) |
modified_at | string (date-time) | Last modification timestamp in UTC. (example: 2018-10-16T09:10:00.000Z) (wire: modifiedAt) |
modified_by | string | Identifier of the user who modified the access key. (example: 0000000006743FDD) (wire: modifiedBy) |
scopes | array | Scopes assigned to the key. ### Alerting - adminMonitorsV2 - viewMonitorsV2 - manageMonitorsV2 ### Data Management - manageApps - viewCollectors - manageCollectors - viewConnections - manageConnections - contentAdmin - viewFieldExtractionRules - manageFieldExtractionRules - viewFields - manageFields - manageBudgets - viewLibrary - manageLibrary - viewPartitions - managePartitions - manageS3DataForwarding - viewScheduledViews - manageScheduledViews - manageTokens ### Logs - runLogSearch ### Metrics - runMetricsQuery ### Reliability Management - viewSlos - manageSlos ### Security - manageAccessKeys - viewPersonalAccessKeys - managePersonalAccessKeys ### UserManagement - viewUsersAndRoles - manageUsersAndRoles |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | region | List all access keys that belong to your user. |
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​
- list
List all access keys that belong to your user.
SELECT
id,
service_account_id,
cors_headers,
created_at,
created_by,
disabled,
effective_scopes,
label,
last_used,
modified_at,
modified_by,
scopes
FROM sumologic.access_keys.personal_access_keys
WHERE region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;