Authentication Schemas

Management.GetLoggedInUserRequest

{}

Properties

None

Management.GetLoggedInUserResponse


{
  "success": true,
  "code": 0,
  "message": "string",
  "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
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none
user	Management.User	false	none	none

Management.GetSessionResponse


{
  "success": true,
  "code": 0,
  "message": "string",
  "user": "string",
  "roles": [
    "string"
  ],
  "permissions": 0,
  "keyName": "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
user	string¦null	false	none	none
roles	[string]¦null	false	none	none
permissions	integer(int32)¦null	false	none	none
keyName	string¦null	false	none	none

Management.LoginRequest


{
  "username": "string",
  "password": "string"
}

Properties

Name	Type	Required	Restrictions	Description
username	string¦null	false	none	none
password	string¦null	false	none	none

Management.LoginResponse


{
  "success": true,
  "code": 0,
  "message": "string",
  "token": "string",
  "expiresIn": 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
token	string¦null	false	none	none
expiresIn	integer(int32)	false	none	none

Management.LogoutRequest

{}

Properties

None

Management.LogoutResponse


{
  "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.UpdateUserSettingsRequest


{
  "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
user	Management.User	false	none	none

Management.UpdateUserSettingsResponse


{
  "success": true,
  "code": 0,
  "message": "string",
  "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
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none
user	Management.User	false	none	none