AlphaAlpha Docs
API Reference

Access Control

API calls for managing user access to subsidiaries and projects

Get current user's access info

GET
/access-control/my-access

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/access-control/my-access"
{
  "accessibleProjectIds": [
    "string"
  ],
  "accessibleSubsidiaryIds": [
    "string"
  ],
  "hasFullAccess": 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 users with project access

GET
/access-control/projects/{id}/users

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/access-control/projects/string/users"
[
  {
    "email": "string",
    "firstName": "string",
    "hasFullAccess": true,
    "inheritedFrom": "string",
    "isDirect": true,
    "lastName": "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"
}

Set users with project access

PUT
/access-control/projects/{id}/users

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PUT "http://localhost:18080/api/v1/access-control/projects/string/users" \  -H "Content-Type: application/json" \  -d '{    "userEmails": [      "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 users with subsidiary access

GET
/access-control/subsidiaries/{id}/users

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/access-control/subsidiaries/string/users"
[
  {
    "email": "string",
    "firstName": "string",
    "hasFullAccess": true,
    "inheritedFrom": "string",
    "isDirect": true,
    "lastName": "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"
}

Set users with subsidiary access

PUT
/access-control/subsidiaries/{id}/users

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PUT "http://localhost:18080/api/v1/access-control/subsidiaries/string/users" \  -H "Content-Type: application/json" \  -d '{    "userEmails": [      "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"
}

Update user's full access flag

PUT
/access-control/users/{email}/full-access

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

email*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

hasFullAccess*boolean

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "http://localhost:18080/api/v1/access-control/users/string/full-access" \  -H "Content-Type: application/json" \  -d '{    "hasFullAccess": true  }'
{
  "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's project access

PUT
/access-control/users/{email}/project-access

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

email*string

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/access-control/users/string/project-access" \  -H "Content-Type: application/json" \  -d '{    "projectIds": [      "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's subsidiary access

PUT
/access-control/users/{email}/subsidiary-access

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

email*string

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/access-control/users/string/subsidiary-access" \  -H "Content-Type: application/json" \  -d '{    "subsidiaryIds": [      "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"
}

API Reference

Interactive API documentation for the Alpha Platform backend endpoints.

Actuator

Next Page