USER

GET User

get

https://api.example.comhttps://staging-api.example.com

/api/v1/user/{userId}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdintegerRequiredExample: 1

Header parameters

tokenstringOptionalExample: abc123def456ghi789jkl012mno345pqr678stu901vwx234yz567abc890

Responses

200

Successful response

application/json

get

/api/v1/user/{userId}

HTTPcURLJavaScriptPython

GET /api/v1/user/{userId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

EDIT User

put

https://api.example.comhttps://staging-api.example.com

/api/v1/user/{userId}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdintegerRequiredExample: 1

Body

application/json

objectOptionalExample: {"name":"John","surname":"Doe","email":"[email protected]","organizations":[2],"roleId":2}

Responses

200

Successful response

application/json

put

/api/v1/user/{userId}

HTTPcURLJavaScriptPython

PUT /api/v1/user/{userId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "name": "John",
  "surname": "Doe",
  "email": "[email protected]",
  "organizations": [
    2
  ],
  "roleId": 2
}

200

Successful response

No content

POST User

post

https://api.example.comhttps://staging-api.example.com

/api/v1/user

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptionalExample: {"name":"Jane","surname":"Smith","email":"[email protected]","organizations":[2]}

Responses

200

Successful response

application/json

post

/api/v1/user

HTTPcURLJavaScriptPython

POST /api/v1/user HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "name": "Jane",
  "surname": "Smith",
  "email": "[email protected]",
  "organizations": [
    2
  ]
}

200

Successful response

No content

EDIT User Password

patch

https://api.example.comhttps://staging-api.example.com

/api/v1/user/{userId}/password-change

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdintegerRequiredExample: 1

Body

application/json

objectOptionalExample: {"password_new":"newpassword123","password_old":"oldpassword123"}

Responses

200

Successful response

application/json

patch

/api/v1/user/{userId}/password-change

HTTPcURLJavaScriptPython

PATCH /api/v1/user/{userId}/password-change HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "password_new": "newpassword123",
  "password_old": "oldpassword123"
}

200

Successful response

No content

Toggle User Permission

post

https://api.example.comhttps://staging-api.example.com

/api/v1/user/{userId}/permission

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdintegerRequiredExample: 1

Body

application/json

objectOptionalExample: {"permissionSlug":"example-permission-slug","name":"Example Permission"}

Responses

200

Successful response

application/json

post

/api/v1/user/{userId}/permission

HTTPcURLJavaScriptPython

POST /api/v1/user/{userId}/permission HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "permissionSlug": "example-permission-slug",
  "name": "Example Permission"
}

200

Successful response

No content

Set Permissions

post

https://api.example.comhttps://staging-api.example.com

/api/v1/user/{userId}/permission/set

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdintegerRequiredExample: 1

Body

application/json

objectOptionalExample: {"slugArray":["permission-slug-1","permission-slug-2"]}

Responses

200

Successful response

application/json

post

/api/v1/user/{userId}/permission/set

HTTPcURLJavaScriptPython

POST /api/v1/user/{userId}/permission/set HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "slugArray": [
    "permission-slug-1",
    "permission-slug-2"
  ]
}

200

Successful response

No content

DELETE User

delete

https://api.example.comhttps://staging-api.example.com

/api/v1/user/{userId}/delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdintegerRequiredExample: 1

Responses

200

Successful response

application/json

delete

/api/v1/user/{userId}/delete

HTTPcURLJavaScriptPython

DELETE /api/v1/user/{userId}/delete HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content