Onboard user in Phoenix auth with RFID/FSS support
POST /users/{userId}/onboard/{applicationName}
Operation id: UserService_OnboardUser
Description
Permission Level: Read-Write
Tags: UserService
Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
applicationName | string | Yes | The application name. Required: false |
userId | string | Yes | user_id of the user to get details, Required: false |
Security
- Authorization (apiKey)
- Bearer token
Responses
200 — A successful response.
Content type: application/json
default — An unexpected error response.
Content type: application/json
Request body
Required: Yes
application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
tenantId | string | No | |
firstName | string | No | |
lastName | string | No |
{
"type": "object",
"properties": {
"tenantId": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
}
}
}
Response models
200 — A successful response.
Content type: application/json
Schema
{
"type": "object",
"properties": {}
}
default — An unexpected error response.
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
code | integer (int32) | No | |
message | string | No | |
details | array | No |
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
}
}
}
}
}
}