Users, Roles and API Keys Schemas

Management.AddUserToRoleRequest


{
  "roles": "string"
}

Properties

Name	Type	Required	Restrictions	Description
roles	string¦null	false	none	none

Management.AddUserToRoleResponse


{
  "success": true,
  "code": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none

Management.ApiKey


{
  "id": 0,
  "name": "string",
  "key": "string",
  "clientSecret": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "expireDate": "2019-08-24T14:15:22Z",
  "ownerId": "string",
  "revoked": true,
  "permissions": 0,
  "description": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)¦null	false	none	none
name	string¦null	false	none	none
key	string¦null	false	none	none
clientSecret	string¦null	false	none	none
createdDate	string(date-time)¦null	false	none	none
expireDate	string(date-time)¦null	false	none	none
ownerId	string¦null	false	none	none
revoked	boolean¦null	false	none	none
permissions	integer(int32)¦null	false	none	none
description	string¦null	false	none	none

Management.DeleteApiKeyResponse


{
  "success": true,
  "code": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none

Management.DeleteUserResponse


{
  "success": true,
  "code": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none

Management.DeleteUserSettingResponse


{
  "success": true,
  "code": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none

Management.GetApiKeysResponse


{
  "success": true,
  "code": 0,
  "message": "string",
  "apiKeys": [
    {
      "id": 0,
      "name": "string",
      "key": "string",
      "clientSecret": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "expireDate": "2019-08-24T14:15:22Z",
      "ownerId": "string",
      "revoked": true,
      "permissions": 0,
      "description": "string"
    }
  ],
  "totalApiKeysCount": 0
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none
apiKeys	[Management.ApiKey]¦null	false	none	none
totalApiKeysCount	integer(int32)¦null	false	none	none

Management.GetRolesResponse


{
  "success": true,
  "code": 0,
  "message": "string",
  "roles": [
    {
      "id": "string",
      "name": "string",
      "description": "string"
    }
  ],
  "totalRolesCount": 0
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none
roles	[Management.Role]¦null	false	none	none
totalRolesCount	integer(int32)¦null	false	none	none

Management.GetUserRolesResponse


{
  "success": true,
  "code": 0,
  "message": "string",
  "roles": [
    {
      "id": "string",
      "name": "string",
      "description": "string"
    }
  ],
  "totalRolesCount": 0
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none
roles	[Management.Role]¦null	false	none	none
totalRolesCount	integer(int32)¦null	false	none	none

Management.GetUserSettingsResponse


{
  "success": true,
  "code": 0,
  "message": "string",
  "settings": [
    {
      "id": 0,
      "category": "string",
      "group": "string",
      "name": "string",
      "value": "string",
      "type": "string",
      "description": "string",
      "readOnly": true,
      "userId": "string"
    }
  ],
  "totalSettingsCount": 0
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none
settings	[Management.UserSetting]¦null	false	none	none
totalSettingsCount	integer(int32)¦null	false	none	none

Management.GetUsersResponse


{
  "success": true,
  "code": 0,
  "message": "string",
  "users": [
    {
      "id": "string",
      "userName": "string",
      "email": "string",
      "phoneNumber": "string",
      "title": "string",
      "firstName": "string",
      "lastName": "string",
      "department": "string",
      "birthDate": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "lastDismissMessages": "2019-08-24T14:15:22Z",
      "lastLogIn": "2019-08-24T14:15:22Z",
      "rank": 0,
      "image": "string",
      "address": "string",
      "postalCode": "string",
      "region": "string",
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "mobile": "string",
      "notes": "string",
      "customerId": 0,
      "roles": [
        "string"
      ],
      "apiKeys": [
        {
          "id": 0,
          "name": "string",
          "key": "string",
          "clientSecret": "string",
          "createdDate": "2019-08-24T14:15:22Z",
          "expireDate": "2019-08-24T14:15:22Z",
          "ownerId": "string",
          "revoked": true,
          "permissions": 0,
          "description": "string"
        }
      ],
      "settings": [
        {
          "id": 0,
          "category": "string",
          "group": "string",
          "name": "string",
          "value": "string",
          "type": "string",
          "description": "string",
          "readOnly": true,
          "userId": "string"
        }
      ]
    }
  ],
  "totalUsersCount": 0
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none
users	[Management.User]¦null	false	none	none
totalUsersCount	integer(int32)¦null	false	none	none

Management.InsertApiKeyRequest


{
  "apiKey": {
    "id": 0,
    "name": "string",
    "key": "string",
    "clientSecret": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "expireDate": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "revoked": true,
    "permissions": 0,
    "description": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
apiKey	Management.ApiKey	false	none	none

Management.InsertApiKeyResponse


{
  "apiKeyId": 0,
  "success": true,
  "code": 0,
  "message": "string",
  "apiKey": "string"
}

Properties

Name	Type	Required	Restrictions	Description
apiKeyId	integer(int32)¦null	false	none	none
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none
apiKey	string¦null	false	none	none

Management.InsertUserRequest


{
  "user": {
    "id": "string",
    "userName": "string",
    "email": "string",
    "phoneNumber": "string",
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "department": "string",
    "birthDate": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "lastDismissMessages": "2019-08-24T14:15:22Z",
    "lastLogIn": "2019-08-24T14:15:22Z",
    "rank": 0,
    "image": "string",
    "address": "string",
    "postalCode": "string",
    "region": "string",
    "city": "string",
    "country": "string",
    "countryCode": "string",
    "mobile": "string",
    "notes": "string",
    "customerId": 0,
    "roles": [
      "string"
    ],
    "apiKeys": [
      {
        "id": 0,
        "name": "string",
        "key": "string",
        "clientSecret": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "expireDate": "2019-08-24T14:15:22Z",
        "ownerId": "string",
        "revoked": true,
        "permissions": 0,
        "description": "string"
      }
    ],
    "settings": [
      {
        "id": 0,
        "category": "string",
        "group": "string",
        "name": "string",
        "value": "string",
        "type": "string",
        "description": "string",
        "readOnly": true,
        "userId": "string"
      }
    ]
  },
  "password": "string"
}

Properties

Name	Type	Required	Restrictions	Description
user	Management.User	false	none	none
password	string¦null	false	none	none

Management.InsertUserResponse


{
  "userId": "string",
  "success": true,
  "code": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
userId	string¦null	false	none	none
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none

Management.InsertUserSettingRequest


{
  "setting": {
    "id": 0,
    "category": "string",
    "group": "string",
    "name": "string",
    "value": "string",
    "type": "string",
    "description": "string",
    "readOnly": true,
    "userId": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
setting	Management.UserSetting	false	none	none

Management.InsertUserSettingResponse


{
  "settingId": 0,
  "success": true,
  "code": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
settingId	integer(int32)¦null	false	none	none
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none

Management.RemoveUserFromRoleRequest


{
  "roles": "string"
}

Properties

Name	Type	Required	Restrictions	Description
roles	string¦null	false	none	none

Management.RemoveUserFromRoleResponse


{
  "success": true,
  "code": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none

Management.Role


{
  "id": "string",
  "name": "string",
  "description": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string¦null	false	none	none
name	string¦null	false	none	none
description	string¦null	false	none	none

Management.UpdateApiKeyRequest


{
  "apiKey": {
    "id": 0,
    "name": "string",
    "key": "string",
    "clientSecret": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "expireDate": "2019-08-24T14:15:22Z",
    "ownerId": "string",
    "revoked": true,
    "permissions": 0,
    "description": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
apiKey	Management.ApiKey	false	none	none

Management.UpdateApiKeyResponse


{
  "success": true,
  "code": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none

Management.UpdateUserRequest


{
  "user": {
    "id": "string",
    "userName": "string",
    "email": "string",
    "phoneNumber": "string",
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "department": "string",
    "birthDate": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "lastDismissMessages": "2019-08-24T14:15:22Z",
    "lastLogIn": "2019-08-24T14:15:22Z",
    "rank": 0,
    "image": "string",
    "address": "string",
    "postalCode": "string",
    "region": "string",
    "city": "string",
    "country": "string",
    "countryCode": "string",
    "mobile": "string",
    "notes": "string",
    "customerId": 0,
    "roles": [
      "string"
    ],
    "apiKeys": [
      {
        "id": 0,
        "name": "string",
        "key": "string",
        "clientSecret": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "expireDate": "2019-08-24T14:15:22Z",
        "ownerId": "string",
        "revoked": true,
        "permissions": 0,
        "description": "string"
      }
    ],
    "settings": [
      {
        "id": 0,
        "category": "string",
        "group": "string",
        "name": "string",
        "value": "string",
        "type": "string",
        "description": "string",
        "readOnly": true,
        "userId": "string"
      }
    ]
  },
  "currentPassword": "string",
  "newPassword": "string"
}

Properties

Name	Type	Required	Restrictions	Description
user	Management.User	false	none	none
currentPassword	string¦null	false	none	none
newPassword	string¦null	false	none	none

Management.UpdateUserResponse


{
  "success": true,
  "code": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none

Management.UpdateUserSettingRequest


{
  "setting": {
    "id": 0,
    "category": "string",
    "group": "string",
    "name": "string",
    "value": "string",
    "type": "string",
    "description": "string",
    "readOnly": true,
    "userId": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
setting	Management.UserSetting	false	none	none

Management.UpdateUserSettingResponse


{
  "settingsId": 0,
  "success": true,
  "code": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
settingsId	integer(int32)¦null	false	none	none
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none

Management.User


{
  "id": "string",
  "userName": "string",
  "email": "string",
  "phoneNumber": "string",
  "title": "string",
  "firstName": "string",
  "lastName": "string",
  "department": "string",
  "birthDate": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "lastDismissMessages": "2019-08-24T14:15:22Z",
  "lastLogIn": "2019-08-24T14:15:22Z",
  "rank": 0,
  "image": "string",
  "address": "string",
  "postalCode": "string",
  "region": "string",
  "city": "string",
  "country": "string",
  "countryCode": "string",
  "mobile": "string",
  "notes": "string",
  "customerId": 0,
  "roles": [
    "string"
  ],
  "apiKeys": [
    {
      "id": 0,
      "name": "string",
      "key": "string",
      "clientSecret": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "expireDate": "2019-08-24T14:15:22Z",
      "ownerId": "string",
      "revoked": true,
      "permissions": 0,
      "description": "string"
    }
  ],
  "settings": [
    {
      "id": 0,
      "category": "string",
      "group": "string",
      "name": "string",
      "value": "string",
      "type": "string",
      "description": "string",
      "readOnly": true,
      "userId": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	string¦null	false	none	none
userName	string¦null	false	none	none
email	string¦null	false	none	none
phoneNumber	string¦null	false	none	none
title	string¦null	false	none	none
firstName	string¦null	false	none	none
lastName	string¦null	false	none	none
department	string¦null	false	none	none
birthDate	string(date-time)¦null	false	none	none
createdAt	string(date-time)¦null	false	none	none
updatedAt	string(date-time)¦null	false	none	none
lastDismissMessages	string(date-time)¦null	false	none	none
lastLogIn	string(date-time)¦null	false	none	none
rank	integer(int32)¦null	false	none	none
image	string(byte)¦null	false	none	none
address	string¦null	false	none	none
postalCode	string¦null	false	none	none
region	string¦null	false	none	none
city	string¦null	false	none	none
country	string¦null	false	none	none
countryCode	string¦null	false	none	none
mobile	string¦null	false	none	none
notes	string¦null	false	none	none
customerId	integer(int32)¦null	false	none	none
roles	[string]¦null	false	none	none
apiKeys	[Management.ApiKey]¦null	false	none	none
settings	[Management.UserSetting]¦null	false	none	none

Management.UserSetting


{
  "id": 0,
  "category": "string",
  "group": "string",
  "name": "string",
  "value": "string",
  "type": "string",
  "description": "string",
  "readOnly": true,
  "userId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	none	none
category	string¦null	false	none	none
group	string¦null	false	none	none
name	string¦null	false	none	none
value	string¦null	false	none	none
type	string¦null	false	none	none
description	string¦null	false	none	none
readOnly	boolean	false	none	none
userId	string¦null	false	none	none