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 getScope(id) → {Promise.<ApiResponse>}
Get scope from COLNEO infohub
Parameters:
Name | Type | Description |
---|---|---|
id |
string
|
Scope ID |
data: Scope
Promise.<ApiResponse>
# async getScopeGroups(id, query) → {Promise.<ApiResponse>}
Get scope groups
Parameters:
Name | Type | Description |
---|---|---|
id |
string
|
Scope ID |
query |
object
|
Query object containing filter, members, etc. |
Promise.<ApiResponse>
# async getScopeRoles(id, query) → {Promise.<ApiResponse>}
Get scope roles
Parameters:
Name | Type | Description |
---|---|---|
id |
string
|
Scope ID |
query |
object
|
Query object containing filter, members, etc. |
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>