leafleafleafFlower illustration
Updated on May 29, 2024
Users

users.Team

Estimated reading: 13 minutes 699 views
Namespace: Users
REST: https://[hoster-api-host]/1.0/users/team/rest/{method-name}
Scripting: users.team.{method-name}

Methods

Create (appid, session, displayName, [ownerUid] ) :

Creates a collaboration Team.

URL

https://[hoster-api-host]/1.0/users/team/rest/create

Parameters

  • appid : “string”

    unique identifier of the target application (required for authentication).

  • session : “string”

    user session or personal access token.

  • displayName : “string”
  • ownerUid : “int” (optional)

    unique identifier of the collaboration Team owner.

Example

Method: POST

https://[hoster-api-host]/1.0/users/team/rest/create?session=[string]&displayName=[string]&appid=[string]&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"
}

Delete (appid, session, teamId, [ownerUid] ) :

eletes a collaboration Team.

URL

https://[hoster-api-host]/1.0/users/team/rest/delete

Parameters

  • appid : “string”

    unique identifier of the target application (required for authentication).

  • session : “string”

    user session or personal access token.

  • teamId : “int”

    unique identifier of the target collaboration Team.

  • ownerUid : “int” (optional)

    unique identifier of the collaboration Team owner.

Example

Method: POST

https://[hoster-api-host]/1.0/users/team/rest/delete?session=[string]&appid=[string]&teamId=[int]&ownerUid=[int]

Response

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

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

Deletes a member from the collaboration Team.

URL

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

Parameters

  • appid : “string”

    unique identifier of the target application (required for authentication).

  • session : “string”

    user session or personal access token.

  • memberId : “int”

    unique identifier of the collaboration Team member.

  • ownerUid : “int” (optional)

    unique identifier of the collaboration Team owner.

Example

Method: POST

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

Response

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

Edit (appid, session, teamId, [displayName], [externalId], [ownerUid] ) :

Edits a collaboration Team.

URL

https://[hoster-api-host]/1.0/users/team/rest/edit

Parameters

  • appid : “string”

    unique identifier of the target application (required for authentication).

  • session : “string”

    user session or personal access token.

  • teamId : “int”

    unique identifier of the target collaboration Team.

  • displayName : “string” (optional)
  • externalId : “string” (optional)

    unique identifier of the collaboration Team that links it with external resources.

  • ownerUid : “int” (optional)

    unique identifier of the collaboration Team owner.

Example

Method: POST

https://[hoster-api-host]/1.0/users/team/rest/edit?session=[string]&displayName=[string]&appid=[string]&teamId=[int]&externalId=[string]&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"
}

Get (appid, session, [ownerUid] ) :

Get list of user teams or owner which passed as ownerUid.

URL

https://[hoster-api-host]/1.0/users/team/rest/get

Parameters

  • appid : “string”

    unique identifier of the target application (required for authentication).

  • session : “string”

    user session or personal access token.

  • ownerUid : “int” (optional)

    unique identifier of the collaboration Team owner.

Example

Method: POST

https://[hoster-api-host]/1.0/users/team/rest/get?session=[string]&appid=[string]&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"
}

Invite (appid, session, email, [displayName], teamId, [ownerUid] ) :

Invites a user to join the collaboration Team.

URL

https://[hoster-api-host]/1.0/users/team/rest/invite

Parameters

  • appid : “string”

    unique identifier of the target application (required for authentication).

  • session : “string”

    user session or personal access token.

  • email : “string”

    email address to send an invitation to.

  • displayName : “string” (optional)

    invited user’s display name (in the collaboration Team owner dashboard).

  • teamId : “int”

    unique identifier of the target collaboration Team.

  • ownerUid : “int” (optional)

    unique identifier of the collaboration Team owner.

Example

Method: POST

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

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"
}

ResendInvite (appid, session, memberId, [ownerUid] ) :

Resends an invitation to join the collaboration Team (for the initial invite use the Invite method instead).

URL

https://[hoster-api-host]/1.0/users/team/rest/resendinvite

Parameters

  • appid : “string”

    unique identifier of the target application (required for authentication).

  • session : “string”

    user session or personal access token.

  • memberId : “int”

    unique identifier of the collaboration Team member.

  • ownerUid : “int” (optional)

    unique identifier of the collaboration Team owner.

Example

Method: POST

https://[hoster-api-host]/1.0/users/team/rest/resendinvite?session=[string]&appid=[string]&ownerUid=[int]&memberId=[int]

Response

  • Response
    {
"error": "string",
"reason": "int",
"result": "int",
"source": "string"
}
Users - Previous users.Account Next - Users users.Authentication

Leave a Comment

Powered By AccuWeb.Cloud