Jump to

• Request
• Response

Get all Users

get

/cloudapi/restapi/v3/user

This operation fetches all users. All attributes and assigned roles are returned for each user.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : User

Type: object

Show Source

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

Nested Schema : CloudTZDateTime

Type: object

Show Source

• millis: integer(int64)
• wrappedDateTime: 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: array associations
  Unique Items Required: true
• bidderCompany: boolean
• createdBy: string
• createdDate: string(date-time)
• displayName(required): string
• id(required): string
• inheritedPolicy: boolean
• isDeletable: boolean
• name(required): string
• parentId: string
• parentName: string
• processed: boolean
• pwdPolicy: object PwdPolicy
• status: string
• statusInfo: string
• type: string
• updatedBy: string
• updatedDate: 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"
        },
        "statusInfo":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "type":"string"
        },
        "processed":{
            "type":"boolean"
        },
        "createdDate":{
            "type":"string",
            "format":"date-time"
        },
        "associations":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string",
                "xml":{
                    "name":"associations"
                }
            }
        },
        "isDeletable":{
            "type":"boolean"
        },
        "bidderCompany":{
            "type":"boolean"
        },
        "parentName":{
            "type":"string"
        },
        "parentId":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "inheritedPolicy":{
            "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: string
• name(required): string

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

Nested Schema : Role

Type: object

Show Source

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

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

400 Response

Invalid input, Please check.

Back to Top