Gets a user password

GET 
/api/web/v1/users/:userid/passwords

Get password information for the specified user. Caller requires the USERPASSWORDS:VIEW permission.

Request

Path Parameters

userid stringrequired

The UUID of the user whose password information is to be fetched.

Responses

200

Successful

application/json

Schema

Schema

expiryNotificationDate date-time

The date at which the next password expiry notification will be sent.

expiryTime date-time

The date at which the password will expire.

forceUpdate boolean

Indicates if the user will be forced to change their password the next time the user authenticates with it.

lastChangedTime date-time

The last time the password was changed.

newPassword string

The value of the new password generated by IDaaS if requested by the client.

present boolean

A flag that indicates if the user has a password.

Example (from schema)

{
  "expiryNotificationDate": "2019-02-19T13:15:27Z",
  "expiryTime": "2019-02-19T13:15:27Z",
  "forceUpdate": true,
  "lastChangedTime": "2019-02-19T13:15:27Z",
  "newPassword": "string",
  "present": true
}

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...