AlphaAlpha Docs
API Reference

User

CRUD controller for users

Find all users

GET
/user

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/user"
[
  {
    "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"
}

Create a new user

POST
/user

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/user" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "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"
}

Update a user

PUT
/user

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 PUT "http://localhost:18080/api/v1/user" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "firstName": "string",    "lastName": "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"
}

Find all super admins

GET
/user/admin

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/user/admin"
[
  {
    "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"
}

Create a new admin user

POST
/user/admin

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/user/admin" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "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"
}

Upload an avatar

POST
/user/avatar/{email}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

email*string

Request Body

multipart/form-data

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/user/avatar/string" \  -F file="string"
{
  "blobId": "string",
  "height": 0,
  "thumbnailBlobId": "string",
  "width": 0
}
{
  "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"
}

Request change password token

GET
/user/change-password/{email}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

email*string
Match.+@.+\..+
Formatemail

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/user/change-password/user@example.com"
"string"
{
  "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"
}

Check email availability

GET
/user/email/{email}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

email*string
Match.+@.+\..+
Formatemail

Response Body

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/user/email/user@example.com"
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"
}

Find a user by email

GET
/user/find/{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/user/find/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"
}

Update user language

PATCH
/user/language

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

[key: string]?string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/user/language" \  -H "Content-Type: application/json" \  -d '{    "property1": "string",    "property2": "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"
}

Leave a tenant

GET
/user/leave-tenant/{tenantId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

tenantId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/user/leave-tenant/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"
}

Get currently logged in user

GET
/user/me

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/user/me"
{
  "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"
}

Find all users for my org

GET
/user/my-org

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/user/my-org"
[
  {
    "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"
}

Change user password

POST
/user/public/change-password

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/user/public/change-password" \  -H "Content-Type: application/json" \  -d '{    "newPassword": "string",    "oldPassword": "string",    "verificationCode": "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"
}

Request a password reset (token)

POST
/user/public/forgot-password

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/user/public/forgot-password" \  -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"
}

Validate password reset token

GET
/user/public/reset-password-token/{email}/{token}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

email*string
token*string

Response Body

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/user/public/reset-password-token/string/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"
}

Verify a user

POST
/user/public/verify

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/user/public/verify" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "newPassword": "string",    "token": "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"
}

Validate verification token

GET
/user/public/verify/validate

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

email*string
token*string

Response Body

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/user/public/verify/validate?email=string&token=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"
}

Reset user password using a token

POST
/user/reset-password

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/user/reset-password" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "newPassword": "string",    "token": "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"
}

Sign up a new user

POST
/user/sign-up

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/user/sign-up" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "firstName": "string",    "lastName": "string",    "tenantName": "string",    "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"
}

Sign up a new client user

POST
/user/sign-up/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/user/sign-up/client" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "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"
}

Switch active tenant

GET
/user/switch-tenant/{tenantId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

tenantId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/user/switch-tenant/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"
}

Get overview of all tenants for a user

GET
/user/tenants

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/user/tenants"
{
  "active": [
    {
      "domain": "string",
      "logoBlobId": "string",
      "roles": [
        "string"
      ],
      "tenantId": "string",
      "tenantName": "string",
      "userStatus": "ACTIVE"
    }
  ],
  "clientMember": [
    {
      "domain": "string",
      "logoBlobId": "string",
      "roles": [
        "string"
      ],
      "tenantId": "string",
      "tenantName": "string",
      "userStatus": "ACTIVE"
    }
  ],
  "inactive": [
    {
      "domain": "string",
      "logoBlobId": "string",
      "roles": [
        "string"
      ],
      "tenantId": "string",
      "tenantName": "string",
      "userStatus": "ACTIVE"
    }
  ],
  "pendingClientInvites": [
    {
      "domain": "string",
      "logoBlobId": "string",
      "roles": [
        "string"
      ],
      "tenantId": "string",
      "tenantName": "string",
      "userStatus": "ACTIVE"
    }
  ],
  "pendingInvites": [
    {
      "domain": "string",
      "logoBlobId": "string",
      "roles": [
        "string"
      ],
      "tenantId": "string",
      "tenantName": "string",
      "userStatus": "ACTIVE"
    }
  ],
  "pendingRequests": [
    {
      "domain": "string",
      "logoBlobId": "string",
      "roles": [
        "string"
      ],
      "tenantId": "string",
      "tenantName": "string",
      "userStatus": "ACTIVE"
    }
  ]
}
{
  "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 invite to join tenant

GET
/user/tenants/invite/accept/{tenantId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

tenantId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/user/tenants/invite/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 invite to join tenant

GET
/user/tenants/invite/deny/{tenantId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

tenantId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/user/tenants/invite/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"
}

Cancel request to join tenant

GET
/user/tenants/request/cancel/{tenantId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

tenantId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/user/tenants/request/cancel/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"
}

Send request to join tenant

GET
/user/tenants/request/join/{tenantId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

tenantId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/user/tenants/request/join/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"
}

Upload a profile picture

POST
/user/upload-profile-picture/{email}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

email*string

Request Body

multipart/form-data

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/user/upload-profile-picture/string" \  -F file="string"
{
  "blobId": "string",
  "height": 0,
  "thumbnailBlobId": "string",
  "width": 0
}
{
  "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 verification email for a new user

POST
/user/verify/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/user/verify/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"
}

Delete a user by email

DELETE
/user/{email}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

email*string

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/user/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"
}

Types

Previous Page

Variables

Next Page