A valid request URL is required to generate request examples{
"User": "<string>",
"UserId": "<string>",
"EmailAddress": "<string>",
"Password": "<string>",
"FederationId": "<string>",
"Roles": "<string>",
"Active": "<string>",
"Authtoken": "<string>",
"ExpiresIn": "<string>",
"ExpiresAt": 123,
"Type": "<string>",
"ClientId": "<string>",
"MFAStatus": "<string>",
"ExpirationTime": 123,
"ResetPassword": "<string>",
"TrustedIPs": "<string>",
"BlockedIPs": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Return a single users
Returns a single users object using the specified key.
A valid request URL is required to generate request examples{
"User": "<string>",
"UserId": "<string>",
"EmailAddress": "<string>",
"Password": "<string>",
"FederationId": "<string>",
"Roles": "<string>",
"Active": "<string>",
"Authtoken": "<string>",
"ExpiresIn": "<string>",
"ExpiresAt": 123,
"Type": "<string>",
"ClientId": "<string>",
"MFAStatus": "<string>",
"ExpirationTime": 123,
"ResetPassword": "<string>",
"TrustedIPs": "<string>",
"BlockedIPs": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Path Parameters
The key User
Query Parameters
Select structural property
Response
users response
The name of the user.
The id of the user.
The email address of the user.
The password to authenticate with. Write-only; masked on read.
The federation id for SSO authentication.
The assigned roles of the user, by name.
Whether the user is active or not. Defaults to true.
The primary authtoken of the user. Masked on read.
The number of days until the auth token expires; -1 means never.
The auth token expiration timestamp, or null if it never expires.
The account kind: 'standard' or 'service'.
The OAuth client id.
Whether MFA is enabled for the user.
The expiration time for a temporary account, as a unix timestamp.
Whether the user must reset the password on next login.
The whitelist of IP addresses.
The blacklist of IP addresses.