# Scopes API

Provides access to the scopes in Hyperproof.

Version: 1.0

## Servers

Hyperproof US
```
https://api.hyperproof.app/v1/scopes
```

Hyperproof Gov
```
https://api.hyperproofgov.app/v1/scopes
```

Hyperproof EU
```
https://api.hyperproof.eu/v1/scopes
```

## Security

### oauth2

Type: oauth2

## Download OpenAPI description

[Scopes API](https://developer.hyperproof.app/_bundle/Hyperproof%20API/Scopes/scopes.openapi.yaml)

## Other

### Get Scopes

 - [GET /](https://developer.hyperproof.app/hyperproof-api/scopes/scopes.openapi/other/get-scopes.md): GET /

#### Description

Retrieves details of all scopes within an organization, including their permissions, boundaries, and associated metadata.

### Bulk Update Scopes

 - [PATCH /](https://developer.hyperproof.app/hyperproof-api/scopes/scopes.openapi/other/patch-scopes.md): PATCH /

#### Description

Updates one or more scopes within an organization, modifying their definitions, permissions, or associated metadata.

### Create Scope

 - [POST /](https://developer.hyperproof.app/hyperproof-api/scopes/scopes.openapi/other/add-scope.md): POST /

#### Description

Creates a new scope within an organization, defining its permissions, boundaries, and associated metadata.

### Filter Scopes

 - [POST /filter](https://developer.hyperproof.app/hyperproof-api/scopes/scopes.openapi/other/get-scopes-filtered.md): POST /filter

#### Description

Retrieves a set of scopes that match the specified filter criteria, returning their definitions, permissions, and related metadata.

### Get Scope

 - [GET /{scopeId}](https://developer.hyperproof.app/hyperproof-api/scopes/scopes.openapi/other/get-scope.md): GET /{scopeId}

#### Description

Retrieves details of a specific scope by its unique ID, including its permissions, boundaries, and associated metadata.

### Update Scope

 - [PATCH /{scopeId}](https://developer.hyperproof.app/hyperproof-api/scopes/scopes.openapi/other/patch-scope.md): PATCH /{scopeId}

#### Description

Updates an existing scope with new values, modifying its permissions, boundaries, or other defined attributes.

### Get Scope Tree

 - [POST /tree](https://developer.hyperproof.app/hyperproof-api/scopes/scopes.openapi/other/get-scope-tree.md): GET /tree

#### Description

Retrieves the full scope tree, returning the hierarchical structure of scopes and their relationships within the organization.