users.Collaboration

Estimated reading: 39 minutes 654 views

Namespace:	Users
REST:	https://[hoster-api-host]/1.0/users/collaboration/rest/{method-name}
Scripting:	users.collaboration.{method-name}

This service is responsible for managing the accounts collaboration feature on the platform. The core idea is that users can share the necessary environments and access to some account features with other platform customers. Complete control over the shared management permissions makes the feature suitable for most possible use cases.

Collaboration owner – a primary account where shared environments are hosted. All charges for the shared environments (including actions performed by collaborators) are applied to this account.
Collaboration member – user account with partial access to the collaboration owner account. Shared functionality is defined by the collaboration owner.
Collaboration (shared) resources – instances (environments, groups) shared in the collaboration.
Collaboration policies – small API sets that allow specific operations.
Collaboration roles – a combination of policies that create the required range of actions to share with members.

Learn more in the documentation.

Methods

AcceptCollaboration

AcceptCollaboration (appid, session, id ) :

Accepts an invitation to join the collaboration.

URL

https://[hoster-api-host]/1.0/users/collaboration/rest/acceptcollaboration

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
id : “int”
unique identifier of the collaboration invite.

Example

Method: POST

https://[hoster-api-host]/1.0/users/collaboration/rest/acceptcollaboration?session=[string]&appid=[string]&id=[int]

Response

CollaborationResponse

{
"collaboration": {
"accountStatus": "string",
"collaborationResources": [
{
"collaboration": {
"accountStatus": "string",
"collaborationResources": [
{
"collaboration": "Collaboration",
"id": "int",
"metadata": "string",
"resourceId": "string",
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "ENV(0) | ENV_GROUP(1) | ACCOUNT(2) | VHI_REGION(3) | S3_REGION(4)",
"useObjectHash": "boolean"
},
"..."
],
"displayName": "string",
"email": "string",
"externalId": "string",
"id": "int",
"memberDisplayName": "string",
"memberUid": "int",
"members": [
{
"displayName": "string",
"email": "string",
"id": "int",
"signedBy": "INVITATION(0) | AZURE_AD(1)",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"useObjectHash": "boolean",
"user": "User"
},
"..."
],
"owner": "User",
"ownerDisplayName": "string",
"ownerUid": "int",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"type": "ACCOUNT(0) | GROUP(1)",
"updatedStatusOn": "date",
"useObjectHash": "boolean"
},
"id": "int",
"metadata": "string",
"resourceId": "string",
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "ENV(0) | ENV_GROUP(1) | ACCOUNT(2) | VHI_REGION(3) | S3_REGION(4)",
"useObjectHash": "boolean"
},
"..."
],
"displayName": "string",
"email": "string",
"externalId": "string",
"id": "int",
"memberDisplayName": "string",
"memberUid": "int",
"members": [
{
"displayName": "string",
"email": "string",
"id": "int",
"signedBy": "INVITATION(0) | AZURE_AD(1)",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"useObjectHash": "boolean",
"user": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
}
},
"..."
],
"owner": {
"authConfig": {
"id": "int",
"isActive": "boolean",
"isConfigured": "boolean",
"type": "TOTP(0)",
"useObjectHash": "boolean"
},
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"ownerDisplayName": "string",
"ownerUid": "int",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"type": "ACCOUNT(0) | GROUP(1)",
"updatedStatusOn": "date",
"useObjectHash": "boolean"
},
"error": "string",
"includeChildren": "boolean",
"isOwner": "boolean",
"reason": "int",
"result": "int",
"source": "string"
}

ActivateMember

ActivateMember (appid, session, id, [ownerUid] ) :

Activates a suspended collaboration member.

URL

https://[hoster-api-host]/1.0/users/collaboration/rest/activatemember

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
id : “int”
unique identifier of the collaboration member.
ownerUid : “int” (optional)
unique identifier of the collaboration owner.

Example

Method: POST

https://[hoster-api-host]/1.0/users/collaboration/rest/activatemember?session=[string]&appid=[string]&id=[int]&ownerUid=[int]

Response

{
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}

AddPolicy

AddPolicy (appid, session, name, methods, [description] ) :

Adds a new custom policy that allows sharing the required actions only.

URL

https://[hoster-api-host]/1.0/users/collaboration/rest/addpolicy

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
name : “string”
custom name for the target policy.
methods : “string”
a comma-separated list of API methods allowed by this new policy.
description : “string” (optional)
custom description for the target new policy.

Example

Method: POST

https://[hoster-api-host]/1.0/users/collaboration/rest/addpolicy?session=[string]&methods=[string]&appid=[string]&name=[string]&description=[string]

Response

PolicyResponse

{
"error": "string",
"policy": {
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": {
"authConfig": {
"id": "int",
"isActive": "boolean",
"isConfigured": "boolean",
"type": "TOTP(0)",
"useObjectHash": "boolean"
},
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"reason": "int",
"result": "int",
"source": "string"
}

AddResources

AddResources (appid, session, collaborationId, resources, [createRoleIfNeeded] ) :

Adds new shared resources (environments and groups) to a collaboration.

URL

https://[hoster-api-host]/1.0/users/collaboration/rest/addresources

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
collaborationId : “int”
unique identifier of the target collaboration.
resources : “string”
JSON object with shared resources (environments and groups) to be added to the collaboration.
createRoleIfNeeded : “boolean” (optional)
defines whether to create a new role for the added shared resources (true) or not (false).

Example

Method: POST

https://[hoster-api-host]/1.0/users/collaboration/rest/addresources?createRoleIfNeeded=[boolean]&session=[string]&appid=[string]&resources=[string]&collaborationId=[int]

Response

CollaborationResourceResponses

{
"error": "string",
"reason": "int",
"responses": [
{
"collaborationId": "int",
"error": "string",
"id": "int",
"memberId": "int",
"metadata": "string",
"ownerUid": "int",
"reason": "int",
"receiveNotification": "boolean",
"resourceId": "string",
"result": "int",
"roleIds": [
"int",
"..."
],
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": {
"authConfig": {
"id": "int",
"isActive": "boolean",
"isConfigured": "boolean",
"type": "TOTP(0)",
"useObjectHash": "boolean"
},
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"source": "string",
"type": "ENV(0) | ENV_GROUP(1) | ACCOUNT(2) | VHI_REGION(3) | S3_REGION(4)",
"uid": "int"
},
"..."
],
"result": "int",
"source": "string"
}

AddRole

AddRole (appid, session, name, [description], policies, receiveNotification ) :

Adds a new role with a custom set of policies to assign to the collaboration members.

URL

https://[hoster-api-host]/1.0/users/collaboration/rest/addrole

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
name : “string”
custom name for the target new role.
description : “string” (optional)
custom description for the target new role.
policies : “string”
a comma-separated list of policies for the target new role.
receiveNotification : “boolean”
defines whether to allow (true) collaboration members with this role to receive load alert notifications about shared environments or not (false).

Example

Method: POST

https://[hoster-api-host]/1.0/users/collaboration/rest/addrole?receiveNotification=[boolean]&session=[string]&appid=[string]&name=[string]&policies=[string]&description=[string]

Response

CollaborationRoleResponse

{
"error": "string",
"reason": "int",
"result": "int",
"role": {
"description": "string",
"id": "int",
"name": "string",
"owner": {
"authConfig": {
"id": "int",
"isActive": "boolean",
"isConfigured": "boolean",
"type": "TOTP(0)",
"useObjectHash": "boolean"
},
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"source": "string"
}

CheckEnvironmentRights

CheckEnvironmentRights (appid, session, serviceMethod, [isAny] ) :

Checks if the account has access to the specified API methods.

URL

https://[hoster-api-host]/1.0/users/collaboration/rest/checkenvironmentrights

Parameters

appid : “string”

unique identifier of the target application (required for authentication).
session : “string”

user session or personal access token.
serviceMethod : “string”

a semicolon-separated list of API methods.
isAny : “boolean” (optional)

defines whether all the listed methods should be allowed (false) or at least one (true).

Example

Method: POST

https://[hoster-api-host]/1.0/users/collaboration/rest/checkenvironmentrights?session=[string]&appid=[string]&isAny=[boolean]&serviceMethod=[string]

Response

{
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}

DeleteMember

DeleteMember (appid, session, id, [ownerUid] ) :

Removes an existing collaboration member.

URL

https://[hoster-api-host]/1.0/users/collaboration/rest/deletemember

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
id : “int”
unique identifier of the target collaboration member.
ownerUid : “int” (optional)
unique identifier of the collaboration owner.

Example

Method: POST

https://[hoster-api-host]/1.0/users/collaboration/rest/deletemember?session=[string]&appid=[string]&id=[int]&ownerUid=[int]

Response

{
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}

DeletePolicy

DeletePolicy (appid, session, id ) :

Removes an existing custom policy.

URL

https://[hoster-api-host]/1.0/users/collaboration/rest/deletepolicy

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
id : “int”
unique identifier of the target custom policy.

Example

Method: POST

https://[hoster-api-host]/1.0/users/collaboration/rest/deletepolicy?session=[string]&appid=[string]&id=[int]

Response

{
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}

DeleteProjectFromResources

DeleteProjectFromResources (appid, session, projectId ) :

Removes the specified project from the collaboration’s shared resources.

URL

https://[hoster-api-host]/1.0/users/collaboration/rest/deleteprojectfromresources

Parameters

appid : “string”

unique identifier of the target application (required for authentication).
session : “string”

user session or personal access token.
projectId : “string”

unique identifier of the target project.

Example

Method: POST

https://[hoster-api-host]/1.0/users/collaboration/rest/deleteprojectfromresources?session=[string]&appid=[string]&projectId=[string]

Response

{
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}

DeleteResources

DeleteResources (appid, session, collaborationId, ids ) :

Removes specified shared resources from the collaboration.

URL

https://[hoster-api-host]/1.0/users/collaboration/rest/deleteresources

Parameters

appid : “string”

unique identifier of the target application (required for authentication).
session : “string”

user session or personal access token.
collaborationId : “int”

unique identifier of the target collaboration.
ids : “list”

a comma-separated list of shared resources identifiers.

Example

Method: POST

https://[hoster-api-host]/1.0/users/collaboration/rest/deleteresources?session=[string]&appid=[string]&ids=[list]&collaborationId=[int]

Response

{
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}

DeleteRole

DeleteRole (appid, session, id ) :

Removes a specified collaboration role.

URL

https://[hoster-api-host]/1.0/users/collaboration/rest/deleterole

Parameters

appid : “string”

unique identifier of the target application (required for authentication).
session : “string”

user session or personal access token.
id : “int”

unique identifier of the target collaboration role to delete.

Example

Method: POST

https://[hoster-api-host]/1.0/users/collaboration/rest/deleterole?session=[string]&appid=[string]&id=[int]

Response

{
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}

EditCollaboration

EditCollaboration (appid, session, id, [displayName] ) :

Adjusts how the specified collaboration is displayed for the collaboration member.

URL

https://[hoster-api-host]/1.0/users/collaboration/rest/editcollaboration

Parameters

appid : “string”

unique identifier of the target application (required for authentication).
session : “string”

user session or personal access token.
id : “int”

unique identifier of the target collaboration to edit.
displayName : “string” (optional)

name of the collaboration displayed in the dashboard.

Example

Method: POST

https://[hoster-api-host]/1.0/users/collaboration/rest/editcollaboration?session=[string]&displayName=[string]&appid=[string]&id=[int]

Response

CollaborationResponse

{
"collaboration": {
"accountStatus": "string",
"collaborationResources": [
{
"collaboration": {
"accountStatus": "string",
"collaborationResources": [
{
"collaboration": "Collaboration",
"id": "int",
"metadata": "string",
"resourceId": "string",
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "ENV(0) | ENV_GROUP(1) | ACCOUNT(2) | VHI_REGION(3) | S3_REGION(4)",
"useObjectHash": "boolean"
},
"..."
],
"displayName": "string",
"email": "string",
"externalId": "string",
"id": "int",
"memberDisplayName": "string",
"memberUid": "int",
"members": [
{
"displayName": "string",
"email": "string",
"id": "int",
"signedBy": "INVITATION(0) | AZURE_AD(1)",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"useObjectHash": "boolean",
"user": "User"
},
"..."
],
"owner": "User",
"ownerDisplayName": "string",
"ownerUid": "int",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"type": "ACCOUNT(0) | GROUP(1)",
"updatedStatusOn": "date",
"useObjectHash": "boolean"
},
"id": "int",
"metadata": "string",
"resourceId": "string",
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "ENV(0) | ENV_GROUP(1) | ACCOUNT(2) | VHI_REGION(3) | S3_REGION(4)",
"useObjectHash": "boolean"
},
"..."
],
"displayName": "string",
"email": "string",
"externalId": "string",
"id": "int",
"memberDisplayName": "string",
"memberUid": "int",
"members": [
{
"displayName": "string",
"email": "string",
"id": "int",
"signedBy": "INVITATION(0) | AZURE_AD(1)",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"useObjectHash": "boolean",
"user": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
}
},
"..."
],
"owner": {
"authConfig": {
"id": "int",
"isActive": "boolean",
"isConfigured": "boolean",
"type": "TOTP(0)",
"useObjectHash": "boolean"
},
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"ownerDisplayName": "string",
"ownerUid": "int",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"type": "ACCOUNT(0) | GROUP(1)",
"updatedStatusOn": "date",
"useObjectHash": "boolean"
},
"error": "string",
"includeChildren": "boolean",
"isOwner": "boolean",
"reason": "int",
"result": "int",
"source": "string"
}

EditMember

EditMember (appid, session, id, [displayName], [ownerUid] ) :

Adjusts how the specified collaboration member is displayed for the collaboration owner.

URL

https://[hoster-api-host]/1.0/users/collaboration/rest/editmember

Parameters

appid : “string”

unique identifier of the target application (required for authentication).
session : “string”

user session or personal access token.
id : “int”

unique identifier of the target collaboration member.
displayName : “string” (optional)

name of the collaboration member displayed in the dashboard.
ownerUid : “int” (optional)

unique identifier of the collaboration owner.

Example

Method: POST

https://[hoster-api-host]/1.0/users/collaboration/rest/editmember?session=[string]&displayName=[string]&appid=[string]&id=[int]&ownerUid=[int]

Response

CollaborationResponse

{
"collaboration": {
"accountStatus": "string",
"collaborationResources": [
{
"collaboration": {
"accountStatus": "string",
"collaborationResources": [
{
"collaboration": "Collaboration",
"id": "int",
"metadata": "string",
"resourceId": "string",
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "ENV(0) | ENV_GROUP(1) | ACCOUNT(2) | VHI_REGION(3) | S3_REGION(4)",
"useObjectHash": "boolean"
},
"..."
],
"displayName": "string",
"email": "string",
"externalId": "string",
"id": "int",
"memberDisplayName": "string",
"memberUid": "int",
"members": [
{
"displayName": "string",
"email": "string",
"id": "int",
"signedBy": "INVITATION(0) | AZURE_AD(1)",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"useObjectHash": "boolean",
"user": "User"
},
"..."
],
"owner": "User",
"ownerDisplayName": "string",
"ownerUid": "int",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"type": "ACCOUNT(0) | GROUP(1)",
"updatedStatusOn": "date",
"useObjectHash": "boolean"
},
"id": "int",
"metadata": "string",
"resourceId": "string",
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "ENV(0) | ENV_GROUP(1) | ACCOUNT(2) | VHI_REGION(3) | S3_REGION(4)",
"useObjectHash": "boolean"
},
"..."
],
"displayName": "string",
"email": "string",
"externalId": "string",
"id": "int",
"memberDisplayName": "string",
"memberUid": "int",
"members": [
{
"displayName": "string",
"email": "string",
"id": "int",
"signedBy": "INVITATION(0) | AZURE_AD(1)",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"useObjectHash": "boolean",
"user": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
}
},
"..."
],
"owner": {
"authConfig": {
"id": "int",
"isActive": "boolean",
"isConfigured": "boolean",
"type": "TOTP(0)",
"useObjectHash": "boolean"
},
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"ownerDisplayName": "string",
"ownerUid": "int",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"type": "ACCOUNT(0) | GROUP(1)",
"updatedStatusOn": "date",
"useObjectHash": "boolean"
},
"error": "string",
"includeChildren": "boolean",
"isOwner": "boolean",
"reason": "int",
"result": "int",
"source": "string"
}

EditPolicy

EditPolicy (appid, session, id, [name], methods, [description] ) :

Adjusts the existing collaboration policy.

URL

https://[hoster-api-host]/1.0/users/collaboration/rest/editpolicy

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
id : “int”
unique identifier of the target policy to edit.
name : “string” (optional)
custom name for the target policy.
methods : “string”
a comma-separated list of API methods allowed by the policy.
description : “string” (optional)
custom description for the target policy.

Example

Method: POST

https://[hoster-api-host]/1.0/users/collaboration/rest/editpolicy?session=[string]&methods=[string]&appid=[string]&name=[string]&description=[string]&id=[int]

Response

PolicyResponse

{
"error": "string",
"policy": {
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": {
"authConfig": {
"id": "int",
"isActive": "boolean",
"isConfigured": "boolean",
"type": "TOTP(0)",
"useObjectHash": "boolean"
},
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"reason": "int",
"result": "int",
"source": "string"
}

EditRole

EditRole (appid, session, id, [name], [description], policies, [receiveNotification] ) :

Adjusts the existing collaboration role.

URL

https://[hoster-api-host]/1.0/users/collaboration/rest/editrole

Parameters

appid : “string”

unique identifier of the target application (required for authentication).
session : “string”

user session or personal access token.
id : “int”

unique identifier of the target role to edit.
name : “string” (optional)

custom name for the target role.
description : “string” (optional)

custom description for the target role.
policies : “string”

a comma-separated list of policies for the target role.
receiveNotification : “boolean” (optional)

defines whether to allow (true) collaboration members with this role to receive load alert notifications about shared environments or not (false).

Example

Method: POST

https://[hoster-api-host]/1.0/users/collaboration/rest/editrole?receiveNotification=[boolean]&session=[string]&appid=[string]&name=[string]&policies=[string]&description=[string]&id=[int]

Response

CollaborationRoleResponse

{
"error": "string",
"reason": "int",
"result": "int",
"role": {
"description": "string",
"id": "int",
"name": "string",
"owner": {
"authConfig": {
"id": "int",
"isActive": "boolean",
"isConfigured": "boolean",
"type": "TOTP(0)",
"useObjectHash": "boolean"
},
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"source": "string"
}

GetCollaborationResourceMethods

GetCollaborationResourceMethods (appid, session, resourceId, resourceType ) :

Returns a list of API methods allowed for the specified collaboration resource.

URL

https://[hoster-api-host]/1.0/users/collaboration/rest/getcollaborationresourcemethods

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
resourceId : “string”
unique identifier of the target collaboration resource.
resourceType : “string”
type (ENV, ENV_GROUP, ACCOUNT, VHI_REGION, S3_REGION) of the target collaboration resource.

Example

Method: POST

https://[hoster-api-host]/1.0/users/collaboration/rest/getcollaborationresourcemethods?resourceId=[string]&session=[string]&appid=[string]&resourceType=[string]

Response

StringArrayResponse

{
"array": [
"string",
"..."
],
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}

GetCollaborationResources

GetCollaborationResources (appid, session, [collaborationId], [type], [resourceGroup] ) :

Returns a list of shared resources for the collaboration.

URL

https://[hoster-api-host]/1.0/users/collaboration/rest/getcollaborationresources

Parameters

appid : “string”

unique identifier of the target application (required for authentication).
session : “string”

user session or personal access token.
collaborationId : “int” (optional)

unique identifier of the target collaboration.
type : “string” (optional)

filters results by the provided resource type (ENV, ENV_GROUP, ACCOUNT, VHI_REGION, S3_REGION).
resourceGroup : “string” (optional)

filters results by the provided resource group (ALL, VAP, CMP).

Example

Method: POST

https://[hoster-api-host]/1.0/users/collaboration/rest/getcollaborationresources?resourceGroup=[string]&session=[string]&appid=[string]&type=[string]&collaborationId=[int]

Response

CollaborationResourceResponses

{
"error": "string",
"reason": "int",
"responses": [
{
"collaborationId": "int",
"error": "string",
"id": "int",
"memberId": "int",
"metadata": "string",
"ownerUid": "int",
"reason": "int",
"receiveNotification": "boolean",
"resourceId": "string",
"result": "int",
"roleIds": [
"int",
"..."
],
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": {
"authConfig": {
"id": "int",
"isActive": "boolean",
"isConfigured": "boolean",
"type": "TOTP(0)",
"useObjectHash": "boolean"
},
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"source": "string",
"type": "ENV(0) | ENV_GROUP(1) | ACCOUNT(2) | VHI_REGION(3) | S3_REGION(4)",
"uid": "int"
},
"..."
],
"result": "int",
"source": "string"
}

GetCollaborationRoleMethods

GetCollaborationRoleMethods (appid, session, [collaborationId], [roleId] ) :

Returns a list of API methods allowed for the specified collaboration role.

URL

https://[hoster-api-host]/1.0/users/collaboration/rest/getcollaborationrolemethods

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
collaborationId : “int” (optional)
unique identifier of the target collaboration.
roleId : “int” (optional)
unique identifier of the target role.

Example

Method: POST

https://[hoster-api-host]/1.0/users/collaboration/rest/getcollaborationrolemethods?session=[string]&roleId=[int]&appid=[string]&collaborationId=[int]

Response

ListResponse

{
"error": "string",
"genericClass": "Class",
"reason": "int",
"responses": [
{
"behavior": "ALLOW(0) | DENY(1)",
"error": "string",
"reason": "int",
"result": "int",
"roleId": "int",
"source": "string",
"tokenPermissions": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
]
},
"..."
],
"result": "int",
"source": "string"
}

GetCollaborations

GetCollaborations (appid, session, [id], [ownerUid], [collaborationType] ) :

Returns information on the specified collaboration(s).

URL

https://[hoster-api-host]/1.0/users/collaboration/rest/getcollaborations

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
id : “int” (optional)
unique identifier of the target collaboration.
ownerUid : “int” (optional)
unique identifier of the collaboration owner.
collaborationType : “string” (optional)
collaboration type (ACCOUNT or GROUP).

Example

Method: POST

https://[hoster-api-host]/1.0/users/collaboration/rest/getcollaborations?collaborationType=[string]&session=[string]&appid=[string]&id=[int]&ownerUid=[int]

Response

CollaborationsResponse

{
"collaborations": [
{
"accountStatus": "string",
"collaborationResources": [
{
"collaboration": {
"accountStatus": "string",
"collaborationResources": [
{
"collaboration": "Collaboration",
"id": "int",
"metadata": "string",
"resourceId": "string",
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "ENV(0) | ENV_GROUP(1) | ACCOUNT(2) | VHI_REGION(3) | S3_REGION(4)",
"useObjectHash": "boolean"
},
"..."
],
"displayName": "string",
"email": "string",
"externalId": "string",
"id": "int",
"memberDisplayName": "string",
"memberUid": "int",
"members": [
{
"displayName": "string",
"email": "string",
"id": "int",
"signedBy": "INVITATION(0) | AZURE_AD(1)",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"useObjectHash": "boolean",
"user": "User"
},
"..."
],
"owner": "User",
"ownerDisplayName": "string",
"ownerUid": "int",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"type": "ACCOUNT(0) | GROUP(1)",
"updatedStatusOn": "date",
"useObjectHash": "boolean"
},
"id": "int",
"metadata": "string",
"resourceId": "string",
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "ENV(0) | ENV_GROUP(1) | ACCOUNT(2) | VHI_REGION(3) | S3_REGION(4)",
"useObjectHash": "boolean"
},
"..."
],
"displayName": "string",
"email": "string",
"externalId": "string",
"id": "int",
"memberDisplayName": "string",
"memberUid": "int",
"members": [
{
"displayName": "string",
"email": "string",
"id": "int",
"signedBy": "INVITATION(0) | AZURE_AD(1)",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"useObjectHash": "boolean",
"user": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
}
},
"..."
],
"owner": {
"authConfig": {
"id": "int",
"isActive": "boolean",
"isConfigured": "boolean",
"type": "TOTP(0)",
"useObjectHash": "boolean"
},
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"ownerDisplayName": "string",
"ownerUid": "int",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"type": "ACCOUNT(0) | GROUP(1)",
"updatedStatusOn": "date",
"useObjectHash": "boolean"
},
"..."
],
"error": "string",
"includeChildren": "boolean",
"isOwner": "boolean",
"reason": "int",
"result": "int",
"source": "string"
}

GetMemberResources

GetMemberResources (appid, session, [memberId], [resourceGroup] ) :

Returns a list of shared resources for the specific member.

URL

https://[hoster-api-host]/1.0/users/collaboration/rest/getmemberresources

Parameters

appid : “string”

unique identifier of the target application (required for authentication).
session : “string”

user session or personal access token.
memberId : “int” (optional)

unique identifier of the target collaboration member.
resourceGroup : “string” (optional)

filters results by the provided resource group (ALL, VAP, CMP).

Example

Method: POST

https://[hoster-api-host]/1.0/users/collaboration/rest/getmemberresources?resourceGroup=[string]&session=[string]&appid=[string]&memberId=[int]

Response

CollaborationResourceResponses

{
"error": "string",
"reason": "int",
"responses": [
{
"collaborationId": "int",
"error": "string",
"id": "int",
"memberId": "int",
"metadata": "string",
"ownerUid": "int",
"reason": "int",
"receiveNotification": "boolean",
"resourceId": "string",
"result": "int",
"roleIds": [
"int",
"..."
],
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": {
"authConfig": {
"id": "int",
"isActive": "boolean",
"isConfigured": "boolean",
"type": "TOTP(0)",
"useObjectHash": "boolean"
},
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"source": "string",
"type": "ENV(0) | ENV_GROUP(1) | ACCOUNT(2) | VHI_REGION(3) | S3_REGION(4)",
"uid": "int"
},
"..."
],
"result": "int",
"source": "string"
}

GetMembers

GetMembers (appid, session, [id], [ownerUid] ) : CollaborationsResponse

Returns information on the specified collaboration member.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
id : “int” (optional)
unique identifier of the target collaboration member.
ownerUid : “int” (optional)
unique identifier of the collaboration owner.

Response

CollaborationsResponse

{
"collaborations": [
{
"accountStatus": "string",
"collaborationResources": [
{
"collaboration": {
"accountStatus": "string",
"collaborationResources": [
{
"collaboration": "Collaboration",
"id": "int",
"metadata": "string",
"resourceId": "string",
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "ENV(0) | ENV_GROUP(1) | ACCOUNT(2) | VHI_REGION(3) | S3_REGION(4)",
"useObjectHash": "boolean"
},
"..."
],
"displayName": "string",
"email": "string",
"externalId": "string",
"id": "int",
"memberDisplayName": "string",
"memberUid": "int",
"members": [
{
"displayName": "string",
"email": "string",
"id": "int",
"signedBy": "INVITATION(0) | AZURE_AD(1)",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"useObjectHash": "boolean",
"user": "User"
},
"..."
],
"owner": "User",
"ownerDisplayName": "string",
"ownerUid": "int",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"type": "ACCOUNT(0) | GROUP(1)",
"updatedStatusOn": "date",
"useObjectHash": "boolean"
},
"id": "int",
"metadata": "string",
"resourceId": "string",
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "ENV(0) | ENV_GROUP(1) | ACCOUNT(2) | VHI_REGION(3) | S3_REGION(4)",
"useObjectHash": "boolean"
},
"..."
],
"displayName": "string",
"email": "string",
"externalId": "string",
"id": "int",
"memberDisplayName": "string",
"memberUid": "int",
"members": [
{
"displayName": "string",
"email": "string",
"id": "int",
"signedBy": "INVITATION(0) | AZURE_AD(1)",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"useObjectHash": "boolean",
"user": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
}
},
"..."
],
"owner": {
"authConfig": {
"id": "int",
"isActive": "boolean",
"isConfigured": "boolean",
"type": "TOTP(0)",
"useObjectHash": "boolean"
},
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"ownerDisplayName": "string",
"ownerUid": "int",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"type": "ACCOUNT(0) | GROUP(1)",
"updatedStatusOn": "date",
"useObjectHash": "boolean"
},
"..."
],
"error": "string",
"includeChildren": "boolean",
"isOwner": "boolean",
"reason": "int",
"result": "int",
"source": "string"
}

Example

https://[hoster-api-host]/1.0/users/collaboration/rest/getmembers?session=[string]&appid=[string]&id=[int]&ownerUid=[int]

GetPolicies

GetPolicies (appid, session, [id] ) : PoliciesResponse

Returns information on the specified collaboration policy.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
id : “int” (optional)
unique identifier of the target policy.

Response

PoliciesResponse

{
"error": "string",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": {
"authConfig": {
"id": "int",
"isActive": "boolean",
"isConfigured": "boolean",
"type": "TOTP(0)",
"useObjectHash": "boolean"
},
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"reason": "int",
"result": "int",
"source": "string"
}

Example

https://[hoster-api-host]/1.0/users/collaboration/rest/getpolicies?session=[string]&appid=[string]&id=[int]

GetPolicyMethods

GetPolicyMethods (appid, session, [policyId] ) : ApiTokenPermissionsResponse

Returns a list of API methods allowed by the specified collaboration policy.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
policyId : “int” (optional)
unique identifier of the target policy.

Response

ApiTokenPermissionsResponse

{
"behavior": "ALLOW(0) | DENY(1)",
"error": "string",
"reason": "int",
"result": "int",
"roleId": "int",
"source": "string",
"tokenPermissions": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
]
}

Example

https://[hoster-api-host]/1.0/users/collaboration/rest/getpolicymethods?policyId=[int]&session=[string]&appid=[string]

GetResourceRoles

GetResourceRoles (appid, session, resourceId, [resourceType], [ownerUid] ) : CollaborationResourceResponses

Returns a list of collaboration roles assigned to the specified collaboration resource.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
resourceId : “string”
unique identifier of the target collaboration resource.
resourceType : “string” (optional)
type (ENV, ENV_GROUP, ACCOUNT, VHI_REGION, S3_REGION) of the provided resource.
ownerUid : “int” (optional)
unique identifier of the collaboration owner.

Response

CollaborationResourceResponses

{
"error": "string",
"reason": "int",
"responses": [
{
"collaborationId": "int",
"error": "string",
"id": "int",
"memberId": "int",
"metadata": "string",
"ownerUid": "int",
"reason": "int",
"receiveNotification": "boolean",
"resourceId": "string",
"result": "int",
"roleIds": [
"int",
"..."
],
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": {
"authConfig": {
"id": "int",
"isActive": "boolean",
"isConfigured": "boolean",
"type": "TOTP(0)",
"useObjectHash": "boolean"
},
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"source": "string",
"type": "ENV(0) | ENV_GROUP(1) | ACCOUNT(2) | VHI_REGION(3) | S3_REGION(4)",
"uid": "int"
},
"..."
],
"result": "int",
"source": "string"
}

Example

https://[hoster-api-host]/1.0/users/collaboration/rest/getresourceroles?resourceId=[string]&session=[string]&appid=[string]&ownerUid=[int]&resourceType=[string]

GetRoles

GetRoles (appid, session, [id], [ownerUid] ) : CollaborationRolesResponse

Returns a list of roles for the specified collaboration.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
id : “int” (optional)
unique identifier of the target collaboration.
ownerUid : “int” (optional)
unique identifier of the collaboration owner.

Response

CollaborationRolesResponse

{
"error": "string",
"reason": "int",
"result": "int",
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": {
"authConfig": {
"id": "int",
"isActive": "boolean",
"isConfigured": "boolean",
"type": "TOTP(0)",
"useObjectHash": "boolean"
},
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"source": "string"
}

Example

https://[hoster-api-host]/1.0/users/collaboration/rest/getroles?session=[string]&appid=[string]&id=[int]&ownerUid=[int]

InviteMember

InviteMember (appid, session, email, [displayName], [ownerUid] ) : CollaborationResponse

Sends an invitation to a user to join the collaboration.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
email : “string”
email address of the user to invite to the collaboration.
displayName : “string” (optional)
custom name for the invited collaboration member.
ownerUid : “int” (optional)
unique identifier of the collaboration owner.

Response

CollaborationResponse

{
"collaboration": {
"accountStatus": "string",
"collaborationResources": [
{
"collaboration": {
"accountStatus": "string",
"collaborationResources": [
{
"collaboration": "Collaboration",
"id": "int",
"metadata": "string",
"resourceId": "string",
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "ENV(0) | ENV_GROUP(1) | ACCOUNT(2) | VHI_REGION(3) | S3_REGION(4)",
"useObjectHash": "boolean"
},
"..."
],
"displayName": "string",
"email": "string",
"externalId": "string",
"id": "int",
"memberDisplayName": "string",
"memberUid": "int",
"members": [
{
"displayName": "string",
"email": "string",
"id": "int",
"signedBy": "INVITATION(0) | AZURE_AD(1)",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"useObjectHash": "boolean",
"user": "User"
},
"..."
],
"owner": "User",
"ownerDisplayName": "string",
"ownerUid": "int",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"type": "ACCOUNT(0) | GROUP(1)",
"updatedStatusOn": "date",
"useObjectHash": "boolean"
},
"id": "int",
"metadata": "string",
"resourceId": "string",
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "ENV(0) | ENV_GROUP(1) | ACCOUNT(2) | VHI_REGION(3) | S3_REGION(4)",
"useObjectHash": "boolean"
},
"..."
],
"displayName": "string",
"email": "string",
"externalId": "string",
"id": "int",
"memberDisplayName": "string",
"memberUid": "int",
"members": [
{
"displayName": "string",
"email": "string",
"id": "int",
"signedBy": "INVITATION(0) | AZURE_AD(1)",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"useObjectHash": "boolean",
"user": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
}
},
"..."
],
"owner": {
"authConfig": {
"id": "int",
"isActive": "boolean",
"isConfigured": "boolean",
"type": "TOTP(0)",
"useObjectHash": "boolean"
},
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"ownerDisplayName": "string",
"ownerUid": "int",
"status": "PENDING(0) | REJECTED(1) | ACTIVE(2) | SUSPENDED(3) | LEFT(4)",
"type": "ACCOUNT(0) | GROUP(1)",
"updatedStatusOn": "date",
"useObjectHash": "boolean"
},
"error": "string",
"includeChildren": "boolean",
"isOwner": "boolean",
"reason": "int",
"result": "int",
"source": "string"
}

Example

https://[hoster-api-host]/1.0/users/collaboration/rest/invitemember?session=[string]&displayName=[string]&appid=[string]&ownerUid=[int]&email=[string]

LeaveCollaboration

LeaveCollaboration (appid, session, id ) : Response

Quits the specified collaboration.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
id : “int”
unique identifier of the target collaboration.

Response

Response
```
{
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}
```
Example
https://[hoster-api-host]/1.0/users/collaboration/rest/leavecollaboration?session=[string]&appid=[string]&id=[int]

RejectCollaboration

RejectCollaboration (appid, session, id ) : Response

Rejects an invitation to join the collaboration.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
id : “int”
unique identifier of the target collaboration.

Response

Response
```
{
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}
```
Example
https://[hoster-api-host]/1.0/users/collaboration/rest/rejectcollaboration?session=[string]&appid=[string]&id=[int]

ResendMemberInvitation

ResendMemberInvitation (appid, session, id, [ownerUid] ) : Response

Re-sends an invitation to a user to join the collaboration.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
id : “int”
unique identifier of the target collaboration member.
ownerUid : “int” (optional)
unique identifier of the collaboration owner.

Response

Response
```
{
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}
```
Example
https://[hoster-api-host]/1.0/users/collaboration/rest/resendmemberinvitation?session=[string]&appid=[string]&id=[int]&ownerUid=[int]

SetResource

SetResource (appid, session, collaborationId, resourceId, [resourceType], roleIds, [ownerUid], [createRoleIfNeeded] ) : CollaborationResourceResponse

Changes a shared resource roles.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
collaborationId : “int”
unique identifier of the target collaboration.
resourceId : “string”
unique identifier of the target collaboration resource.
resourceType : “string” (optional)
type (ENV, ENV_GROUP, ACCOUNT, VHI_REGION, S3_REGION) of the provided resource.
roleIds : “string”
a comma-separated list of the role IDs for the provided resource.
ownerUid : “int” (optional)
unique identifier of the collaboration owner.
createRoleIfNeeded : “boolean” (optional)
defines whether to create a new role for the added shared resources (true) or not (false).

Response

CollaborationResourceResponse

{
"collaborationId": "int",
"error": "string",
"id": "int",
"memberId": "int",
"metadata": "string",
"ownerUid": "int",
"reason": "int",
"receiveNotification": "boolean",
"resourceId": "string",
"result": "int",
"roleIds": [
"int",
"..."
],
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": {
"authConfig": {
"id": "int",
"isActive": "boolean",
"isConfigured": "boolean",
"type": "TOTP(0)",
"useObjectHash": "boolean"
},
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"source": "string",
"type": "ENV(0) | ENV_GROUP(1) | ACCOUNT(2) | VHI_REGION(3) | S3_REGION(4)",
"uid": "int"
}

Example

https://[hoster-api-host]/1.0/users/collaboration/rest/setresource?resourceId=[string]&createRoleIfNeeded=[boolean]&roleIds=[string]&session=[string]&appid=[string]&ownerUid=[int]&collaborationId=[int]&resourceType=[string]

SetResources

SetResources (appid, session, collaborationId, resources, [createRoleIfNeeded] ) : CollaborationResourceResponses

Changes shared resources assigned to the specified collaboration.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
collaborationId : “int”
unique identifier of the target collaboration.
resources : “string”
JSON object with shared resources (environments and groups) to be added to the collaboration.
createRoleIfNeeded : “boolean” (optional)
Defines whether to create a new role for the added shared resources (true) or not (false).

Response

CollaborationResourceResponses

{
"error": "string",
"reason": "int",
"responses": [
{
"collaborationId": "int",
"error": "string",
"id": "int",
"memberId": "int",
"metadata": "string",
"ownerUid": "int",
"reason": "int",
"receiveNotification": "boolean",
"resourceId": "string",
"result": "int",
"roleIds": [
"int",
"..."
],
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": {
"authConfig": {
"id": "int",
"isActive": "boolean",
"isConfigured": "boolean",
"type": "TOTP(0)",
"useObjectHash": "boolean"
},
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": {
"authConfig": "AuthConfig",
"authType": "BASIC(0) | TFA(1)",
"email": "string",
"externalId": "string",
"federationType": "string",
"id": "int",
"name": "string",
"phoneNumber": "string",
"tenantHost": "boolean",
"tenantId": "string"
},
"roles": [
{
"description": "string",
"id": "int",
"name": "string",
"owner": "User",
"policies": [
{
"apiListItems": [
{
"id": "int",
"isCollaborationAccessible": "boolean",
"isSafe": "boolean",
"method": "string",
"useObjectHash": "boolean"
},
"..."
],
"behavior": "ALLOW(0) | DENY(1)",
"description": "string",
"id": "int",
"isSystem": "boolean",
"name": "string",
"owner": "User",
"roles": [
"CollaborationRole",
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"type": "COLLABORATION(0) | ENVIRONMENT(1) | CMP(2)",
"uniqueName": "string",
"useObjectHash": "boolean"
},
"..."
],
"receiveNotification": "boolean",
"type": "VAP(0) | CMP(1)",
"useObjectHash": "boolean"
},
"..."
],
"source": "string",
"type": "ENV(0) | ENV_GROUP(1) | ACCOUNT(2) | VHI_REGION(3) | S3_REGION(4)",
"uid": "int"
},
"..."
],
"result": "int",
"source": "string"
}

Example

https://[hoster-api-host]/1.0/users/collaboration/rest/setresources?createRoleIfNeeded=[boolean]&session=[string]&appid=[string]&resources=[string]&collaborationId=[int]

SuspendMember

SuspendMember (appid, session, id, [ownerUid] ) : Response

Excludes a member from the collaboration without removing the user’s data and current collaboration setup. It allows easy re-activation of this user in the future if needed.

Parameters

appid : “string”
unique identifier of the target application (required for authentication).
session : “string”
user session or personal access token.
id : “int”
unique identifier of the target collaboration member.
ownerUid : “int” (optional)
unique identifier of the collaboration owner.

Response

Response
```
{
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}
```
Example
https://[hoster-api-host]/1.0/users/collaboration/rest/suspendmember?session=[string]&appid=[string]&id=[int]&ownerUid=[int]