ScopeServices Class Reference

Description

Functions to get scope information from infohub.

Public Member Functions
	constructor (ctx)
async	createScope (ScopeInfo_new)
async	deleteScope (id)
async	getLicencesOfScope (scopeid)
async	getScopeById (scopeid)
async	getScopeGroups (id, query)
async	getScopeRoles (id, query)
async	getScopesOfUser (userid)
async	updateScope (id, ScopeInfo_update)

Function Documentation

constructor()

constructor

(

ctx

)

Since

1.0, 09.2025, aab

Parameters

{Context}

ctx - Context instance

createScope()

async createScope

(

ScopeInfo_new

)

Create scope.

Parameters

{object}	ScopeInfo_new - Scope information
{string}	[ScopeInfo_new.name] - Scope name
{string}	[ScopeInfo_new.description] - Scope description

Returns

{Promise<ApiResponse>}

deleteScope()

async deleteScope

(

id

)

Delete scope.

Parameters

{string}

id - Scope ID

Returns

{Promise<ApiResponse>}

getLicencesOfScope()

async getLicencesOfScope

(

scopeid

)

Get licences within a scope.

Parameters

{string}

scopeid - Scope ID

Returns

{Promise<ApiResponse>}

getScopeById()

async getScopeById

(

scopeid

)

Get scope from COLNEO infohub.

Returns

{Promise<ApiResponse>} data: Scope

Parameters

{string}

scopeid - Scope ID

getScopeGroups()

async getScopeGroups	(		id,
			query )

Get scope groups.

Parameters

{string}	id - Scope ID
{object}	query - Query object containing filter, members, etc.
{string}	[query.filter] - Filter
{string}	[query.members] - Members

Returns

{Promise<ApiResponse>}

getScopeRoles()

async getScopeRoles	(		id,
			query )

Get scope roles.

Parameters

{string}	id - Scope ID
{object}	query - Query object containing filter, members, etc.
{string}	[query.filter] - Filter
{string}	[query.members] - Members

Returns

{Promise<ApiResponse>}

getScopesOfUser()

async getScopesOfUser

(

userid

)

Get scopes of a user by user ID.

Since

09.2025, aab

Parameters

{string}

userid - User ID

Returns

{Promise<ApiResponse>}

updateScope()

async updateScope	(		id,
			ScopeInfo_update )

Update scope.

Parameters

{string}	id - Scope ID
{object}	ScopeInfo_update - Scope information
{string}	[ScopeInfo_update.name] - Scope name
{string}	[ScopeInfo_update.description] - Scope description

Returns

{Promise<ApiResponse>}