Jump to

• Request
• Response
• Examples

Enable/Disable users.

put

/cloudapi/restapi/user/change-status

This operation enables or disables a set of users depending on the status of the users. If the user status input is the same as the user status in the database, no change is made.

Request

Body ()

Root Schema : List<UserRO>

Type: array

Title: List<UserRO>

Show Source

• Array of: object User

{
    "title":"List<UserRO>",
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserRO"
    }
}

Nested 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"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : schema

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : additionalProperties

Type: object

400 Response

Invalid input, Please check.

500 Response

Internal Server Error. Underlying Identity Management System threw an error, Please check the logs.

Back to Top

Examples

Method

PUT

Response Content Type

application/json

Operation

/cloudapi/restapi/user/change-status

cURL Example

REQUEST URL: http://<hostname>:<port>/cloudapi/restapi/user/change-status

curl -X PUT http://<hostname>:<port>/cloudapi/restapi/user/change-status -H 'accept: application/json' -H 'content-type: application/json' -d

'[{"loginId": "JSMITH","disabled":true,"id":"3336"},{"loginId":"DPATEL","locked":true,"id":"3449"}

]'

Request Body Example

[{"loginId": "JSMITH","disabled":true,"id":"3336"},

{"loginId": "DPATEL","disabled":true,"id":"3449"}

]

Response Body Example

{

"3336": "",

"3449": ""

}

Back to Top