Patch
/identity/users/{userId}/customerGuest
Required permissions: READ_GUEST_USER, INVITE_GUEST_USER.
Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired
The name of the target tenant (e.g. acme).
Path parameters
userId
stringRequired
The user identifier.
Minimum1.0
Exampleabcd1234
Body parameters
The invited user details to patch.
object
authorization
string
The authorization of the user on the thing.
Valid values[
"GRANT",
"DENY"
]
userTypeId
string
The identifier of the user-type the user impersonate when operating on the associated thing.
limitedTime
object
The time limitation of this authorization.
startDayTime
number
Example1000
endDayTime
number
Example2230
weekDays
Array of string
string
Valid values[
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
]
startTimestamp
integer (int64)
Example1578438000000
endTimestamp
integer (int64)
Example1578438000000
Responses
200
Invite updated.
400
Request data not valid.
object
message
string
The error response.
ExampleBad request
401
User not authenticated.
object
message
string
The error response.
ExampleUser not authenticated
403
User not authorized.
object
message
string
The error response.
ExampleUser not authorized
404
Resource was not found.
object
message
string
The error response.
ExampleResource not found
429
API call rate limit exeeded.
object
message
string
The error response.
ExampleAPI call rate limit exeeded
500
Internal server error.
object
message
string
The error response.
ExampleInternal Server Error