Skip to main content

scopes

Creates, updates, deletes, gets or lists a scopes resource.

Overview

Namescopes
TypeResource
Idsumologic.oauth.scopes

Fields

The following fields are returned by SELECT queries:

A list of scopes that can be added to an oauth client.

NameDatatypeDescription
idstringThe name of the scope. (example: managePartitions)
depends_onarrayAny scopes that are required for this scope to be enabled. (wire: dependsOn)
groupobjectThe group that the scope belongs to.
labelstringThe UI label for the scope. (example: Manage Partitions)
typestringType of scope. (example: Manage)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectregionGet a list of all of the scopes that can be added to an oauth client.

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.

NameDatatypeDescription
regionstringSumo 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 a list of all of the scopes that can be added to an oauth client.

SELECT
id,
depends_on,
group,
label,
type
FROM sumologic.oauth.scopes
WHERE region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;