Jump to

• Request
• Response
• Examples

Get User

get

/cloudapi/restapi/user/{userId}

This operation fetches a user. All attributes and assigned roles for the user are returned.

Request

Path Parameters

• userId: string
  LoginId of the user being requested.

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : User

Type: object

Show Source

• admin(optional): boolean
• changePwdAtNextLogin(optional): boolean
• createdBy(optional): string
• createdDate(optional): object CloudTZDateTime
• deprovisionedDate(optional): string(date-time)
• deprovisioningDate(optional): string(date-time)
• disabled: boolean
• emailAddress: string
• employeeNumber(optional): string
• endDate(optional): string(date-time)
• firstName: string
• id(optional): string
• lastName: string
• locked(optional): boolean
• loginAttemptsCtr(optional): string
• loginId: string
• manager(optional): string
• middleName(optional): string
• organization: object Organization
• password(optional): array password
• processed(optional): boolean
• provisionedDate(optional): string(date-time)
• provisioningDate(optional): string(date-time)
• pwdCantChange(optional): boolean
• pwdExpired(optional): boolean
• pwdExpireDate(optional): string(date-time)
• pwdWarnDate(optional): string(date-time)
• pwdWarned(optional): boolean
• roles(optional): array roles
• startDate(optional): string(date-time)
• status(optional): string
• statusInfo(optional): string
• statusInfoOK(optional): boolean
• updatedDate(optional): object CloudTZDateTime
• userType(optional): string

{
    "type":"object",
    "required":[
        "disabled",
        "emailAddress",
        "firstName",
        "lastName",
        "loginId",
        "organization"
    ],
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "password":{
            "type":"array",
            "items":{
                "type":"string",
                "xml":{
                    "name":"password"
                }
            }
        },
        "manager":{
            "type":"string"
        },
        "roles":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"roles"
                },
                "$ref":"#/definitions/RoleRO"
            }
        },
        "loginId":{
            "type":"string"
        },
        "updatedDate":{
            "$ref":"#/definitions/CloudTZDateTime"
        },
        "organization":{
            "$ref":"#/definitions/CompanyRO"
        },
        "loginAttemptsCtr":{
            "type":"string"
        },
        "provisionedDate":{
            "type":"string",
            "format":"date-time"
        },
        "employeeNumber":{
            "type":"string"
        },
        "provisioningDate":{
            "type":"string",
            "format":"date-time"
        },
        "deprovisioningDate":{
            "type":"string",
            "format":"date-time"
        },
        "changePwdAtNextLogin":{
            "type":"boolean"
        },
        "deprovisionedDate":{
            "type":"string",
            "format":"date-time"
        },
        "statusInfo":{
            "type":"string"
        },
        "statusInfoOK":{
            "type":"boolean"
        },
        "firstName":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "emailAddress":{
            "type":"string"
        },
        "middleName":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "startDate":{
            "type":"string",
            "format":"date-time"
        },
        "endDate":{
            "type":"string",
            "format":"date-time"
        },
        "createdDate":{
            "$ref":"#/definitions/CloudTZDateTime"
        },
        "pwdExpireDate":{
            "type":"string",
            "format":"date-time"
        },
        "pwdWarnDate":{
            "type":"string",
            "format":"date-time"
        },
        "disabled":{
            "type":"boolean"
        },
        "pwdExpired":{
            "type":"boolean"
        },
        "userType":{
            "type":"string"
        },
        "admin":{
            "type":"boolean"
        },
        "pwdCantChange":{
            "type":"boolean"
        },
        "processed":{
            "type":"boolean"
        },
        "pwdWarned":{
            "type":"boolean"
        },
        "locked":{
            "type":"boolean"
        }
    },
    "xml":{
        "name":"User"
    }
}

Nested Schema : CloudTZDateTime

Type: object

Show Source

• millis(optional): integer(int64)
• wrappedDateTime(optional): string(date-time)

{
    "type":"object",
    "properties":{
        "millis":{
            "type":"integer",
            "format":"int64"
        },
        "wrappedDateTime":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : Organization

Type: object

Show Source

• associations(optional): array associations
  Unique Items Required: true
• bidderCompany(optional): boolean
• createdBy(optional): string
• createdDate(optional): string(date-time)
• displayName: string
• id: string
• inheritedPolicy(optional): boolean
• isDeletable(optional): boolean
• name: string
• parentId(optional): string
• parentName(optional): string
• processed(optional): boolean
• pwdPolicy(optional): object PwdPolicy
• status(optional): string
• statusInfo(optional): string
• type(optional): string
• updatedBy(optional): string
• updatedDate(optional): string(date-time)

{
    "type":"object",
    "required":[
        "displayName",
        "id",
        "name"
    ],
    "properties":{
        "pwdPolicy":{
            "$ref":"#/definitions/ShortPasswordPolicyRO"
        },
        "name":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string",
            "format":"date-time"
        },
        "inheritedPolicy":{
            "type":"boolean"
        },
        "statusInfo":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "createdDate":{
            "type":"string",
            "format":"date-time"
        },
        "processed":{
            "type":"boolean"
        },
        "parentName":{
            "type":"string"
        },
        "parentId":{
            "type":"string"
        },
        "isDeletable":{
            "type":"boolean"
        },
        "updatedBy":{
            "type":"string"
        },
        "associations":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string",
                "xml":{
                    "name":"associations"
                }
            }
        },
        "bidderCompany":{
            "type":"boolean"
        }
    },
    "xml":{
        "name":"Organization"
    }
}

Nested Schema : password

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string",
        "xml":{
            "name":"password"
        }
    }
}

Nested Schema : roles

Type: array

Show Source

• Array of: object Role

{
    "type":"array",
    "items":{
        "xml":{
            "name":"roles"
        },
        "$ref":"#/definitions/RoleRO"
    }
}

Nested Schema : associations

Type: array

Unique Items Required: true

Show Source

• Array of: string

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "type":"string",
        "xml":{
            "name":"associations"
        }
    }
}

Nested Schema : PwdPolicy

Type: object

Show Source

• id(optional): string
• name: string

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    },
    "xml":{
        "name":"PwdPolicy"
    }
}

Nested Schema : Role

Type: object

Show Source

• companyAccessType(optional): boolean
• displayName(optional): string
• id(optional): string
• name: string
• userAccessType(optional): string

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "userAccessType":{
            "type":"string"
        },
        "companyAccessType":{
            "type":"boolean"
        }
    },
    "xml":{
        "name":"Role"
    }
}

400 Response

Invalid input, Please check.

Back to Top

Examples

Method

GET

Response Content Type

application/json

Operation

/cloudapi/restapi/user/{userId}

cURL Example

REQUEST URL: http://<hostname>:<port>/cloudapi/restapi/user/JSMITH

curl -X GET "http://<hostname>:<port>/cloudapi/restapi/user/JSMITH" -H "accept: application/json"

Response Body Example

{

"loginId": "JSMITH",

"updatedDate": "2018-05-11T08:04:50",

"statusInfo": "",

"organization": {

"associations": [],

"inheritedPolicy": false,

"isDeletable": false,

"bidderCompany": false,

"displayName": "sfo",

"id": "4",

"name": "sfo"

},

"emailAddress": "[e-mail]",

"disabled": false,

"locked": false,

"status": "Active",

"createdBy": "COADMIN",

"pwdExpireDate": "2019-02-18T17:11:47",

"pwdWarnDate": "2018-09-21T17:11:47",

"pwdExpired": false,

"pwdCantChange": false,

"pwdWarned": false,

"loginAttemptsCtr": "0",

"lastAction": "Updated",

"firstName": "Jim",

"lastName": "Smith",

"userType": "Employee",

"createdDate": "2018-04-09T15:21:25",

"provisionedDate": "2018-04-09T15:26:49",

"changePwdAtNextLogin": true,

"id": "3336"

}

Back to Top