admin

GET`/admin.one`

admin-one

Authorization

`Authorization`
Required
Bearer <token>

In: header

Status code	Description
`200`	Successful response
`default`	Error response

curl -X GET "http://localhost:3000/api/admin.one"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST`/admin.createUserInvitation`

admin-createUserInvitation

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`email`
Required
string

Format: "email"

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/admin.createUserInvitation" \
  -d '{
  "email": "user@example.com"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST`/admin.removeUser`

admin-removeUser

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`authId`
Required
string

Minimum length: 1

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/admin.removeUser" \
  -d '{
  "authId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET`/admin.getUserByToken`

admin-getUserByToken

Authorization

`Authorization`
Required
Bearer <token>

In: header

Query Parameters

`token`
Required
string

Minimum length: 1

Status code	Description
`200`	Successful response
`default`	Error response

curl -X GET "http://localhost:3000/api/admin.getUserByToken?token=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST`/admin.assignPermissions`

admin-assignPermissions

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`userId`
Required
string

Minimum length: 1

`canCreateProjects`
Required
boolean

`canCreateServices`
Required
boolean

`canDeleteProjects`
Required
boolean

`canDeleteServices`
Required
boolean

`accesedProjects`
Required
array<string>

`accesedServices`
Required
array<string>

`canAccessToTraefikFiles`
Required
boolean

`canAccessToDocker`
Required
boolean

`canAccessToAPI`
Required
boolean

`canAccessToSSHKeys`
Required
boolean

`canAccessToGitProviders`
Required
boolean

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/admin.assignPermissions" \
  -d '{
  "userId": "string",
  "canCreateProjects": true,
  "canCreateServices": true,
  "canDeleteProjects": true,
  "canDeleteServices": true,
  "accesedProjects": [
    "string"
  ],
  "accesedServices": [
    "string"
  ],
  "canAccessToTraefikFiles": true,
  "canAccessToDocker": true,
  "canAccessToAPI": true,
  "canAccessToSSHKeys": true,
  "canAccessToGitProviders": true
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

admin

GET/admin.one

AuthorizationRequiredBearer <token>

Response

Typescript

POST/admin.createUserInvitation

AuthorizationRequiredBearer <token>

emailRequiredstring

Response

Typescript

POST/admin.removeUser

AuthorizationRequiredBearer <token>

authIdRequiredstring

Response

Typescript

GET/admin.getUserByToken

AuthorizationRequiredBearer <token>

tokenRequiredstring

Response

Typescript

POST/admin.assignPermissions

AuthorizationRequiredBearer <token>

userIdRequiredstring

canCreateProjectsRequiredboolean

canCreateServicesRequiredboolean

canDeleteProjectsRequiredboolean

canDeleteServicesRequiredboolean

accesedProjectsRequiredarray<string>

accesedServicesRequiredarray<string>

canAccessToTraefikFilesRequiredboolean

canAccessToDockerRequiredboolean

canAccessToAPIRequiredboolean

canAccessToSSHKeysRequiredboolean

canAccessToGitProvidersRequiredboolean

Response

Typescript

On this page

GET`/admin.one`

`Authorization`
Required
Bearer <token>

POST`/admin.createUserInvitation`

`Authorization`
Required
Bearer <token>

`email`
Required
string

POST`/admin.removeUser`

`Authorization`
Required
Bearer <token>

`authId`
Required
string

GET`/admin.getUserByToken`

`Authorization`
Required
Bearer <token>

`token`
Required
string

POST`/admin.assignPermissions`

`Authorization`
Required
Bearer <token>

`userId`
Required
string

`canCreateProjects`
Required
boolean

`canCreateServices`
Required
boolean

`canDeleteProjects`
Required
boolean

`canDeleteServices`
Required
boolean

`accesedProjects`
Required
array<string>

`accesedServices`
Required
array<string>

`canAccessToTraefikFiles`
Required
boolean

`canAccessToDocker`
Required
boolean

`canAccessToAPI`
Required
boolean

`canAccessToSSHKeys`
Required
boolean

`canAccessToGitProviders`
Required
boolean