Classes
Methods
# async createScope(ScopeInfo_new) → {Promise.<ApiResponse>}
Create scope
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
ScopeInfo_new |
object
|
Scope information |
|
name |
string
|
<optional> |
Scope name |
description |
string
|
<optional> |
Scope description |
Promise.<ApiResponse>
# async deleteScope(id) → {Promise.<ApiResponse>}
Delete scope
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string
|
Scope ID |
Promise.<ApiResponse>
# async getLicencesOfScope(scopeid) → {Promise.<ApiResponse>}
Get licences within a scope
Parameters:
| Name | Type | Description |
|---|---|---|
scopeid |
string
|
Scope ID |
Promise.<ApiResponse>
# async getScopeById(scopeid) → {Promise.<ApiResponse>}
Get scope from COLNEO infohub
Parameters:
| Name | Type | Description |
|---|---|---|
scopeid |
string
|
Scope ID |
data: Scope
Promise.<ApiResponse>
# async getScopeGroups(id, query) → {Promise.<ApiResponse>}
Get scope groups
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
string
|
Scope ID |
|
query |
object
|
Query object containing filter, members, etc. |
|
filter |
string
|
<optional> |
Filter |
members |
string
|
<optional> |
Members |
Promise.<ApiResponse>
# async getScopeRoles(id, query) → {Promise.<ApiResponse>}
Get scope roles
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
string
|
Scope ID |
|
query |
object
|
Query object containing filter, members, etc. |
|
filter |
string
|
<optional> |
Filter |
members |
string
|
<optional> |
Members |
Promise.<ApiResponse>
# async getScopesOfUser(userid) → {Promise.<ApiResponse>}
Get scopes of a user by user ID
Parameters:
| Name | Type | Description |
|---|---|---|
userid |
string
|
User ID |
- Since:
- 09.2025, aab
Promise.<ApiResponse>
# async updateScope(id, ScopeInfo_update) → {Promise.<ApiResponse>}
Update scope
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
string
|
Scope ID |
|
ScopeInfo_update |
object
|
Scope information |
|
name |
string
|
<optional> |
Scope name |
description |
string
|
<optional> |
Scope description |
Promise.<ApiResponse>