AlphaAlpha Docs
API ReferenceTenants

Tenants / Members

API calls concerning tenant members

Get all active members for tenant

GET
/tenants/members/active

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/tenants/members/active"
[
  {
    "email": "string",
    "firstName": "string",
    "hasFullAccess": true,
    "id": "string",
    "language": "string",
    "lastLogin": "2019-08-24T14:15:22Z",
    "lastName": "string",
    "profile": {
      "avatar": {
        "blobId": "string",
        "height": 0,
        "thumbnailBlobId": "string",
        "width": 0
      },
      "displayName": "string",
      "logo": {
        "blobId": "string",
        "height": 0,
        "thumbnailBlobId": "string",
        "width": 0
      }
    },
    "projectAccess": [
      "string"
    ],
    "roles": [
      "string"
    ],
    "status": "ACTIVE",
    "subsidiaryAccess": [
      "string"
    ],
    "tenantId": "string",
    "verified": true
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Invites user to tenant

POST
/tenants/members/invite

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/tenants/members/invite" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "sendEmail": true,    "verificationBaseUrl": "string"  }'
{
  "email": "string",
  "firstName": "string",
  "hasFullAccess": true,
  "id": "string",
  "language": "string",
  "lastLogin": "2019-08-24T14:15:22Z",
  "lastName": "string",
  "profile": {
    "avatar": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    },
    "displayName": "string",
    "logo": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    }
  },
  "projectAccess": [
    "string"
  ],
  "roles": [
    "string"
  ],
  "status": "ACTIVE",
  "subsidiaryAccess": [
    "string"
  ],
  "tenantId": "string",
  "verified": true
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Cancel user invite to tenant

GET
/tenants/members/invite/cancel/{email}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

email*string

Response Body

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/tenants/members/invite/cancel/string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Invites client user to tenant

POST
/tenants/members/invite/client

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/tenants/members/invite/client" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "sendEmail": true,    "verificationBaseUrl": "string"  }'
{
  "email": "string",
  "firstName": "string",
  "hasFullAccess": true,
  "id": "string",
  "language": "string",
  "lastLogin": "2019-08-24T14:15:22Z",
  "lastName": "string",
  "profile": {
    "avatar": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    },
    "displayName": "string",
    "logo": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    }
  },
  "projectAccess": [
    "string"
  ],
  "roles": [
    "string"
  ],
  "status": "ACTIVE",
  "subsidiaryAccess": [
    "string"
  ],
  "tenantId": "string",
  "verified": true
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Resend invitation email to user

POST
/tenants/members/invite/resend

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/tenants/members/invite/resend" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "verificationBaseUrl": "string"  }'
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get all pending members for tenant

GET
/tenants/members/pending

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/tenants/members/pending"
{
  "pendingClientInvites": [
    {
      "email": "string",
      "firstName": "string",
      "hasFullAccess": true,
      "id": "string",
      "language": "string",
      "lastLogin": "2019-08-24T14:15:22Z",
      "lastName": "string",
      "profile": {
        "avatar": {
          "blobId": "string",
          "height": 0,
          "thumbnailBlobId": "string",
          "width": 0
        },
        "displayName": "string",
        "logo": {
          "blobId": "string",
          "height": 0,
          "thumbnailBlobId": "string",
          "width": 0
        }
      },
      "projectAccess": [
        "string"
      ],
      "roles": [
        "string"
      ],
      "status": "ACTIVE",
      "subsidiaryAccess": [
        "string"
      ],
      "tenantId": "string",
      "verified": true
    }
  ],
  "pendingInvites": [
    {
      "email": "string",
      "firstName": "string",
      "hasFullAccess": true,
      "id": "string",
      "language": "string",
      "lastLogin": "2019-08-24T14:15:22Z",
      "lastName": "string",
      "profile": {
        "avatar": {
          "blobId": "string",
          "height": 0,
          "thumbnailBlobId": "string",
          "width": 0
        },
        "displayName": "string",
        "logo": {
          "blobId": "string",
          "height": 0,
          "thumbnailBlobId": "string",
          "width": 0
        }
      },
      "projectAccess": [
        "string"
      ],
      "roles": [
        "string"
      ],
      "status": "ACTIVE",
      "subsidiaryAccess": [
        "string"
      ],
      "tenantId": "string",
      "verified": true
    }
  ],
  "pendingRequests": [
    {
      "email": "string",
      "firstName": "string",
      "hasFullAccess": true,
      "id": "string",
      "language": "string",
      "lastLogin": "2019-08-24T14:15:22Z",
      "lastName": "string",
      "profile": {
        "avatar": {
          "blobId": "string",
          "height": 0,
          "thumbnailBlobId": "string",
          "width": 0
        },
        "displayName": "string",
        "logo": {
          "blobId": "string",
          "height": 0,
          "thumbnailBlobId": "string",
          "width": 0
        }
      },
      "projectAccess": [
        "string"
      ],
      "roles": [
        "string"
      ],
      "status": "ACTIVE",
      "subsidiaryAccess": [
        "string"
      ],
      "tenantId": "string",
      "verified": true
    }
  ]
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Remove user from tenant

GET
/tenants/members/remove/{email}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

email*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/tenants/members/remove/string"
{
  "email": "string",
  "firstName": "string",
  "hasFullAccess": true,
  "id": "string",
  "language": "string",
  "lastLogin": "2019-08-24T14:15:22Z",
  "lastName": "string",
  "profile": {
    "avatar": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    },
    "displayName": "string",
    "logo": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    }
  },
  "projectAccess": [
    "string"
  ],
  "roles": [
    "string"
  ],
  "status": "ACTIVE",
  "subsidiaryAccess": [
    "string"
  ],
  "tenantId": "string",
  "verified": true
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Accept user request to join tenant

GET
/tenants/members/request/accept/{email}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

email*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/tenants/members/request/accept/string"
{
  "email": "string",
  "firstName": "string",
  "hasFullAccess": true,
  "id": "string",
  "language": "string",
  "lastLogin": "2019-08-24T14:15:22Z",
  "lastName": "string",
  "profile": {
    "avatar": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    },
    "displayName": "string",
    "logo": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    }
  },
  "projectAccess": [
    "string"
  ],
  "roles": [
    "string"
  ],
  "status": "ACTIVE",
  "subsidiaryAccess": [
    "string"
  ],
  "tenantId": "string",
  "verified": true
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Deny user request to join tenant

GET
/tenants/members/request/deny/{email}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

email*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/tenants/members/request/deny/string"
{
  "email": "string",
  "firstName": "string",
  "hasFullAccess": true,
  "id": "string",
  "language": "string",
  "lastLogin": "2019-08-24T14:15:22Z",
  "lastName": "string",
  "profile": {
    "avatar": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    },
    "displayName": "string",
    "logo": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    }
  },
  "projectAccess": [
    "string"
  ],
  "roles": [
    "string"
  ],
  "status": "ACTIVE",
  "subsidiaryAccess": [
    "string"
  ],
  "tenantId": "string",
  "verified": true
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Waste

Previous Page

Types / Mass

Next Page