Scopes

The SysCloud API uses scopes to control access to different resources and actions within the API. By assigning specific scopes to access tokens, you can limit the permissions granted to client applications.

Available Scopes

The SysCloud API defines the following scopes:

• Jobs: Scopes to view and interact with Jobs.
• Reports: Scopes to access restore and export reports.
• Entities: Scopes to access Entity data.
• Trends: Scopes to access backup and restore trends data.

Scope Permissions

Each scope grants access to specific resources or actions within the SysCloud API. Below are the permissions associated with each scope:

Jobs

• Jobs.Read: Read Jobs data including scope of a job.

Reports

• Reports.Restore.Read: Read restore reports and items added in each restore.
• Reports.Export.Read: Read export reports and items added in each export.

Entities

• Entity.Read: Read sync entities for all clouds.

Trends

• Trends.Read: Read backup, restore, and export trends.

Using Scopes

To access resources or perform actions requiring specific scopes, clients must include those scopes when requesting access tokens from the SysCloud API. Ensure that your application requests only the scopes necessary for its functionality to minimize the risk of unauthorized access.

Scope Validation

The SysCloud API validates the scopes included in access tokens to determine whether the requested actions or resources are authorized for the requesting client. If the token does not include the required scopes, the corresponding request may be denied with a 403 Forbidden error.