accessKeyManagement

Update an access key.

Updates the properties of existing accessKey by accessId. It can be used to enable or disable the access key and to update the corsHeaders list.

put/v1/accessKeys/{id}

Request

  • Base URL
    https://api.au.sumologic.com/api
  • URL
    https://api.au.sumologic.com/api/v1/accessKeys/{id}
  • Auth
    HTTP basic

Path parameters

idstring required

The accessId of the access key to update.

Request body

disabledboolean required

Indicates whether the access key is disabled or not.

corsHeadersstring[]

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.
scopesstring[]

Scopes assigned to the key. <br><br> Note: Updates to scopes will take up to 5m to reflect due to caching in the system.

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

Example request

{
  "disabled": true,
  "corsHeaders": [
    "https://my-app.com",
    "https://mail.my-app.com"
  ],
  "scopes": [
    "manageUsersAndRoles",
    "viewCollectors"
  ]
}

Response

Access key updated successfully.

idstring required

Identifier of the access key.

labelstring required

The name of the access key.

corsHeadersstring[]

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.
disabledboolean required

Indicates whether the access key is disabled or not.

createdAtstring date-time required

Creation timestamp in UTC in RFC3339 format.

createdBystring required

Identifier of the user who created the access key.

modifiedAtstring date-time required

Last modification timestamp in UTC.

modifiedBystring required

Identifier of the user who modified the access key.

serviceAccountIdstring

Identifier of the service account who owns the access key.

lastUsedstring date-time

Last used timestamp in UTC. <br> Note: Property not in use, it is part of an upcoming feature.

scopesstring[]

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
effectiveScopesstring[]

Effective scopes based on the intersection of the user's RBAC capabilities and the assigned scopes.

Example response

{
  "id": "su0w3Q37CBzHUM",
  "label": "collector access key",
  "corsHeaders": [
    "https://my-app.com",
    "https://mail.my-app.com"
  ],
  "createdAt": "2018-10-16T09:10:00Z",
  "createdBy": "0000000006743FDD",
  "modifiedAt": "2018-10-16T09:10:00Z",
  "modifiedBy": "0000000006743FDD",
  "serviceAccountId": "0000000006743FDA",
  "lastUsed": "2018-10-16T09:10:00Z",
  "scopes": [
    "manageUsersAndRoles",
    "viewCollectors"
  ],
  "effectiveScopes": [
    "manageUsersAndRoles",
    "viewCollectors"
  ]
}

Changes

No recorded changes to this operation across all 15 revisions of this API.