Jump to

• Request
• Response

Get Job status

get

/cloudapi/restapi/user/status/{jobId}

This operation reveals the status corresponding to the job {jobId}. If the job is complete, the operation returns OK (200), otherwise the operation returns ACCEPTED (202) with the location header in the response. Example request: GET /cloudapi/restapi/user/status/12345

Request

Path Parameters

• jobId(required): string
  Job Id for which the status is being requested.

  Example:

  12345

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Create/Modify Users job has been successfully executed.

Body ()

Root Schema : UserDataStore

Type: object

Title: UserDataStore

User create, update, delete request payload and job result.

Show Source

• added: array List<UserRO>
  Title: List<UserRO>

  Users to create.
• deleted: array List<string>
  Title: List<string>

  User login IDs to delete.
• deleteFailed: array List<UserRO>
  Title: List<UserRO>

  Users that failed delete processing.
• exception: string
  Title: exception

  Error key or message returned when processing fails.
• localizedException: boolean
  Title: localizedException

  Indicates whether exception messages are localization keys.
• message: string
  Title: message

  Additional status message for the request or job.
• modified: array List<UserRO>
  Title: List<UserRO>

  Users to update.
• updatedIdMap: object updatedIdMap
  Title: updatedIdMap

  Additional Properties Allowed: additionalProperties

  Mapping of original user identifiers to updated identifiers.

{
    "title":"UserDataStore",
    "type":"object",
    "properties":{
        "added":{
            "title":"List<UserRO>",
            "type":"array",
            "description":"Users to create.",
            "items":{
                "$ref":"#/components/schemas/UserRO"
            }
        },
        "modified":{
            "title":"List<UserRO>",
            "type":"array",
            "description":"Users to update.",
            "items":{
                "$ref":"#/components/schemas/UserRO"
            }
        },
        "deleted":{
            "title":"List<string>",
            "type":"array",
            "description":"User login IDs to delete.",
            "items":{
                "type":"string"
            }
        },
        "deleteFailed":{
            "title":"List<UserRO>",
            "type":"array",
            "description":"Users that failed delete processing.",
            "items":{
                "$ref":"#/components/schemas/UserRO"
            }
        },
        "updatedIdMap":{
            "title":"updatedIdMap",
            "type":"object",
            "additionalProperties":{
                "type":"string",
                "description":"Mapping of original user identifiers to updated identifiers."
            },
            "description":"Mapping of original user identifiers to updated identifiers."
        },
        "exception":{
            "title":"exception",
            "type":"string",
            "description":"Error key or message returned when processing fails."
        },
        "message":{
            "title":"message",
            "type":"string",
            "description":"Additional status message for the request or job."
        },
        "localizedException":{
            "title":"localizedException",
            "type":"boolean",
            "description":"Indicates whether exception messages are localization keys."
        }
    },
    "description":"User create, update, delete request payload and job result."
}

Nested Schema : List<UserRO>

Type: array

Title: List<UserRO>

Users to create.

Show Source

• Array of: object UserRO
  Title: UserRO

  User record used by Cloud Administration user management APIs.

{
    "title":"List<UserRO>",
    "type":"array",
    "description":"Users to create.",
    "items":{
        "$ref":"#/components/schemas/UserRO"
    }
}

Nested Schema : List<string>

Type: array

Title: List<string>

User login IDs to delete.

Show Source

• Array of: string

{
    "title":"List<string>",
    "type":"array",
    "description":"User login IDs to delete.",
    "items":{
        "type":"string"
    }
}

Nested Schema : List<UserRO>

Type: array

Title: List<UserRO>

Users that failed delete processing.

Show Source

• Array of: object UserRO
  Title: UserRO

  User record used by Cloud Administration user management APIs.

{
    "title":"List<UserRO>",
    "type":"array",
    "description":"Users that failed delete processing.",
    "items":{
        "$ref":"#/components/schemas/UserRO"
    }
}

Nested Schema : List<UserRO>

Type: array

Title: List<UserRO>

Users to update.

Show Source

• Array of: object UserRO
  Title: UserRO

  User record used by Cloud Administration user management APIs.

{
    "title":"List<UserRO>",
    "type":"array",
    "description":"Users to update.",
    "items":{
        "$ref":"#/components/schemas/UserRO"
    }
}

Nested Schema : updatedIdMap

Type: object

Title: updatedIdMap

Additional Properties Allowed

Show Source

• string
  Mapping of original user identifiers to updated identifiers.

{
    "title":"updatedIdMap",
    "type":"object",
    "additionalProperties":{
        "type":"string",
        "description":"Mapping of original user identifiers to updated identifiers."
    },
    "description":"Mapping of original user identifiers to updated identifiers."
}

Mapping of original user identifiers to updated identifiers.

Nested Schema : UserRO

Type: object

Title: UserRO

User record used by Cloud Administration user management APIs.

Show Source

• admin: boolean
  Title: admin

  Indicates whether the user has administrator privileges.
• changePwdAtNextLogin: boolean
  Title: changePwdAtNextLogin

  Read Only: true

  Indicates whether the user must change password at next login.
• createdBy: string
  Title: createdBy

  Read Only: true

  User or process that created this record.
• createdDate: object CloudTZDateTime
  Title: CloudTZDateTime

  Read Only: true

  Date and time when the password was last reset.
• deprovisionedDate: string (date-time)
  Title: deprovisionedDate

  Read Only: true

  Date and time when the user was deprovisioned.
• deprovisioningDate: string (date-time)
  Title: deprovisioningDate

  Read Only: true

  Date and time when user deprovisioning started.
• disabled(required): boolean
  Title: disabled

  Indicates whether the user account is disabled.
• emailAddress(required): string
  Title: emailAddress

  User email address.
• employeeNumber: string
  Title: employeeNumber

  Employee number associated with the user.
• endDate: string (date-time)
  Title: endDate

  Date after which the user account is inactive.
• firstName(required): string
  Title: firstName

  User first name.
• id: string
  Title: id

  Read Only: true

  Internal user identifier.
• lastName(required): string
  Title: lastName

  User last name.
• lastPasswordResetDate: object CloudTZDateTime
  Title: CloudTZDateTime

  Read Only: true

  Date and time when the password was last reset.
• locked: boolean
  Title: locked

  Indicates whether the user account is locked.
• loginAttemptsCtr: string
  Title: loginAttemptsCtr

  Read Only: true

  Number of failed login attempts.
• loginId(required): string
  Title: loginId

  User login identifier.
• manager: string
  Title: manager

  Manager login identifier or name.
• middleName: string
  Title: middleName

  User middle name.
• organization(required): object CompanyRO
  Title: CompanyRO

  Company or organization record used by Cloud Administration APIs.
• password: string (password)
  Title: password

  Password to set for password reset operations.
• processed: boolean
  Title: processed

  Read Only: true

  Indicates whether the user record has been processed by a create or update job.
• provisionedDate: string (date-time)
  Title: provisionedDate

  Read Only: true

  Date and time when the user was provisioned.
• provisioningDate: string (date-time)
  Title: provisioningDate

  Read Only: true

  Date and time when user provisioning started.
• pwdCantChange: boolean
  Title: pwdCantChange

  Indicates whether the user is prevented from changing the password.
• pwdExpired: boolean
  Title: pwdExpired

  Read Only: true

  Indicates whether the user password has expired.
• pwdExpireDate: string (date-time)
  Title: pwdExpireDate

  Read Only: true

  Date and time when the current password expires.
• pwdWarnDate: string (date-time)
  Title: pwdWarnDate

  Read Only: true

  Date and time when password expiration warning starts.
• pwdWarned: boolean
  Title: pwdWarned

  Read Only: true

  Indicates whether the user has been warned about password expiration.
• roles: array List<RoleRO>
  Title: List<RoleRO>

  Roles assigned to the user.
• startDate: string (date-time)
  Title: startDate

  Date from which the user account is active.
• status: string
  Title: status

  User account status.
• statusInfo: string
  Title: statusInfo

  Read Only: true

  Processing status details for create or update jobs.
• statusInfoOK: boolean
  Title: statusInfoOK
• updatedDate: object CloudTZDateTime
  Title: CloudTZDateTime

  Read Only: true

  Date and time when the password was last reset.
• userType: string
  Title: userType

  User type.

{
    "title":"UserRO",
    "required":[
        "disabled",
        "emailAddress",
        "firstName",
        "lastName",
        "loginId",
        "organization"
    ],
    "type":"object",
    "properties":{
        "id":{
            "title":"id",
            "type":"string",
            "description":"Internal user identifier.",
            "readOnly":true
        },
        "status":{
            "title":"status",
            "type":"string",
            "description":"User account status."
        },
        "endDate":{
            "title":"endDate",
            "type":"string",
            "description":"Date after which the user account is inactive.",
            "format":"date-time"
        },
        "middleName":{
            "title":"middleName",
            "type":"string",
            "description":"User middle name."
        },
        "employeeNumber":{
            "title":"employeeNumber",
            "type":"string",
            "description":"Employee number associated with the user."
        },
        "firstName":{
            "title":"firstName",
            "type":"string",
            "description":"User first name."
        },
        "emailAddress":{
            "title":"emailAddress",
            "type":"string",
            "description":"User email address."
        },
        "manager":{
            "title":"manager",
            "type":"string",
            "description":"Manager login identifier or name."
        },
        "createdBy":{
            "title":"createdBy",
            "type":"string",
            "description":"User or process that created this record.",
            "readOnly":true
        },
        "lastName":{
            "title":"lastName",
            "type":"string",
            "description":"User last name."
        },
        "startDate":{
            "title":"startDate",
            "type":"string",
            "description":"Date from which the user account is active.",
            "format":"date-time"
        },
        "locked":{
            "title":"locked",
            "type":"boolean",
            "description":"Indicates whether the user account is locked."
        },
        "pwdExpireDate":{
            "title":"pwdExpireDate",
            "type":"string",
            "description":"Date and time when the current password expires.",
            "format":"date-time",
            "readOnly":true
        },
        "updatedDate":{
            "$ref":"#/components/schemas/CloudTZDateTime"
        },
        "createdDate":{
            "$ref":"#/components/schemas/CloudTZDateTime"
        },
        "pwdWarnDate":{
            "title":"pwdWarnDate",
            "type":"string",
            "description":"Date and time when password expiration warning starts.",
            "format":"date-time",
            "readOnly":true
        },
        "provisionedDate":{
            "title":"provisionedDate",
            "type":"string",
            "description":"Date and time when the user was provisioned.",
            "format":"date-time",
            "readOnly":true
        },
        "disabled":{
            "title":"disabled",
            "type":"boolean",
            "description":"Indicates whether the user account is disabled."
        },
        "roles":{
            "title":"List<RoleRO>",
            "type":"array",
            "description":"Roles assigned to the user.",
            "items":{
                "$ref":"#/components/schemas/RoleRO"
            }
        },
        "organization":{
            "$ref":"#/components/schemas/CompanyRO"
        },
        "pwdCantChange":{
            "title":"pwdCantChange",
            "type":"boolean",
            "description":"Indicates whether the user is prevented from changing the password."
        },
        "pwdWarned":{
            "title":"pwdWarned",
            "type":"boolean",
            "description":"Indicates whether the user has been warned about password expiration.",
            "readOnly":true
        },
        "processed":{
            "title":"processed",
            "type":"boolean",
            "description":"Indicates whether the user record has been processed by a create or update job.",
            "readOnly":true
        },
        "pwdExpired":{
            "title":"pwdExpired",
            "type":"boolean",
            "description":"Indicates whether the user password has expired.",
            "readOnly":true
        },
        "userType":{
            "title":"userType",
            "type":"string",
            "description":"User type."
        },
        "statusInfo":{
            "title":"statusInfo",
            "type":"string",
            "description":"Processing status details for create or update jobs.",
            "readOnly":true
        },
        "admin":{
            "title":"admin",
            "type":"boolean",
            "description":"Indicates whether the user has administrator privileges."
        },
        "loginId":{
            "title":"loginId",
            "type":"string",
            "description":"User login identifier."
        },
        "statusInfoOK":{
            "title":"statusInfoOK",
            "type":"boolean"
        },
        "password":{
            "title":"password",
            "type":"string",
            "description":"Password to set for password reset operations.",
            "format":"password",
            "writeOnly":true
        },
        "lastPasswordResetDate":{
            "$ref":"#/components/schemas/CloudTZDateTime"
        },
        "provisioningDate":{
            "title":"provisioningDate",
            "type":"string",
            "description":"Date and time when user provisioning started.",
            "format":"date-time",
            "readOnly":true
        },
        "deprovisioningDate":{
            "title":"deprovisioningDate",
            "type":"string",
            "description":"Date and time when user deprovisioning started.",
            "format":"date-time",
            "readOnly":true
        },
        "deprovisionedDate":{
            "title":"deprovisionedDate",
            "type":"string",
            "description":"Date and time when the user was deprovisioned.",
            "format":"date-time",
            "readOnly":true
        },
        "changePwdAtNextLogin":{
            "title":"changePwdAtNextLogin",
            "type":"boolean",
            "description":"Indicates whether the user must change password at next login.",
            "readOnly":true
        },
        "loginAttemptsCtr":{
            "title":"loginAttemptsCtr",
            "type":"string",
            "description":"Number of failed login attempts.",
            "readOnly":true
        }
    },
    "description":"User record used by Cloud Administration user management APIs.",
    "xml":{
        "name":"User"
    }
}

Nested Schema : CloudTZDateTime

Type: object

Title: CloudTZDateTime

Read Only: true

Date and time when the password was last reset.

Show Source

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

{
    "title":"CloudTZDateTime",
    "type":"object",
    "properties":{
        "millis":{
            "title":"millis",
            "type":"integer",
            "format":"int64"
        },
        "wrappedDateTime":{
            "title":"wrappedDateTime",
            "type":"string",
            "format":"date-time"
        }
    },
    "description":"Date and time when the password was last reset.",
    "readOnly":true
}

Nested Schema : CompanyRO

Type: object

Title: CompanyRO

Company or organization record used by Cloud Administration APIs.

Show Source

• associations: array List<string>
  Title: List<string>

  Unique Items Required: true

  Role or product associations for the company.
• bidderCompany: boolean
  Title: bidderCompany

  Indicates whether the company is a bidder company.
• createdBy: string
  Title: createdBy

  Read Only: true

  User or process that created the company.
• createdDate: string (date-time)
  Title: createdDate

  Read Only: true

  Date and time when the company was created.
• displayName(required): string
  Title: displayName

  Display name for the company.
• id(required): string
  Title: id

  Internal company identifier.
• inheritedPolicy: boolean
  Title: inheritedPolicy

  Indicates whether the password policy is inherited from a parent company.
• isDeletable: boolean
  Title: isDeletable

  Read Only: true

  Indicates whether the company can be deleted.
• name(required): string
  Title: name

  Company name.
• parentId: string
  Title: parentId

  Identifier of the parent company.
• parentName: string
  Title: parentName

  Name of the parent company.
• processed: boolean
  Title: processed

  Read Only: true

  Indicates whether the company record has been processed.
• pwdPolicy: object ShortPasswordPolicyRO
  Title: ShortPasswordPolicyRO

  Summary password policy associated with a company.
• status: string
  Title: status

  Company status.
• statusInfo: string
  Title: statusInfo

  Read Only: true

  Processing status details for create or update requests.
• type: string
  Title: type

  Company type.
• updatedBy: string
  Title: updatedBy

  Read Only: true

  User or process that last updated the company.
• updatedDate: string (date-time)
  Title: updatedDate

  Read Only: true

  Date and time when the company was last updated.

{
    "title":"CompanyRO",
    "required":[
        "displayName",
        "id",
        "name"
    ],
    "type":"object",
    "properties":{
        "pwdPolicy":{
            "$ref":"#/components/schemas/ShortPasswordPolicyRO"
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"Company name."
        },
        "id":{
            "title":"id",
            "type":"string",
            "description":"Internal company identifier."
        },
        "type":{
            "title":"type",
            "type":"string",
            "description":"Company type."
        },
        "displayName":{
            "title":"displayName",
            "type":"string",
            "description":"Display name for the company."
        },
        "status":{
            "title":"status",
            "type":"string",
            "description":"Company status."
        },
        "createdBy":{
            "title":"createdBy",
            "type":"string",
            "description":"User or process that created the company.",
            "readOnly":true
        },
        "updatedDate":{
            "title":"updatedDate",
            "type":"string",
            "description":"Date and time when the company was last updated.",
            "format":"date-time",
            "readOnly":true
        },
        "createdDate":{
            "title":"createdDate",
            "type":"string",
            "description":"Date and time when the company was created.",
            "format":"date-time",
            "readOnly":true
        },
        "processed":{
            "title":"processed",
            "type":"boolean",
            "description":"Indicates whether the company record has been processed.",
            "readOnly":true
        },
        "statusInfo":{
            "title":"statusInfo",
            "type":"string",
            "description":"Processing status details for create or update requests.",
            "readOnly":true
        },
        "parentId":{
            "title":"parentId",
            "type":"string",
            "description":"Identifier of the parent company."
        },
        "updatedBy":{
            "title":"updatedBy",
            "type":"string",
            "description":"User or process that last updated the company.",
            "readOnly":true
        },
        "parentName":{
            "title":"parentName",
            "type":"string",
            "description":"Name of the parent company."
        },
        "inheritedPolicy":{
            "title":"inheritedPolicy",
            "type":"boolean",
            "description":"Indicates whether the password policy is inherited from a parent company."
        },
        "associations":{
            "title":"List<string>",
            "uniqueItems":true,
            "type":"array",
            "description":"Role or product associations for the company.",
            "items":{
                "type":"string",
                "description":"Role or product associations for the company.",
                "xml":{
                    "name":"associations"
                }
            }
        },
        "isDeletable":{
            "title":"isDeletable",
            "type":"boolean",
            "description":"Indicates whether the company can be deleted.",
            "readOnly":true
        },
        "bidderCompany":{
            "title":"bidderCompany",
            "type":"boolean",
            "description":"Indicates whether the company is a bidder company."
        }
    },
    "description":"Company or organization record used by Cloud Administration APIs.",
    "xml":{
        "name":"Organization"
    }
}

Nested Schema : List<RoleRO>

Type: array

Title: List<RoleRO>

Roles assigned to the user.

Show Source

• Array of: object RoleRO
  Title: RoleRO

  Application role assigned to a user or company.

{
    "title":"List<RoleRO>",
    "type":"array",
    "description":"Roles assigned to the user.",
    "items":{
        "$ref":"#/components/schemas/RoleRO"
    }
}

Nested Schema : List<string>

Type: array

Title: List<string>

Unique Items Required: true

Role or product associations for the company.

Show Source

• Array of: string
  Role or product associations for the company.

{
    "title":"List<string>",
    "uniqueItems":true,
    "type":"array",
    "description":"Role or product associations for the company.",
    "items":{
        "type":"string",
        "description":"Role or product associations for the company.",
        "xml":{
            "name":"associations"
        }
    }
}

Nested Schema : ShortPasswordPolicyRO

Type: object

Title: ShortPasswordPolicyRO

Summary password policy associated with a company.

Show Source

• id: string
  Title: id

  Password policy identifier.
• name(required): string
  Title: name

  Password policy name.

{
    "title":"ShortPasswordPolicyRO",
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "title":"name",
            "type":"string",
            "description":"Password policy name."
        },
        "id":{
            "title":"id",
            "type":"string",
            "description":"Password policy identifier."
        }
    },
    "description":"Summary password policy associated with a company.",
    "xml":{
        "name":"PwdPolicy"
    }
}

Nested Schema : RoleRO

Type: object

Title: RoleRO

Application role assigned to a user or company.

Show Source

• companyAccessType: boolean
  Title: companyAccessType

  Indicates whether the role grants company-level access.
• displayName: string
  Title: displayName

  Display name for the role.
• id: string
  Title: id

  Read Only: true

  Internal role identifier.
• name(required): string
  Title: name

  Role name.
• userAccessType: string
  Title: userAccessType

  User access type granted by the role.

{
    "title":"RoleRO",
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "title":"name",
            "type":"string",
            "description":"Role name."
        },
        "id":{
            "title":"id",
            "type":"string",
            "description":"Internal role identifier.",
            "readOnly":true
        },
        "displayName":{
            "title":"displayName",
            "type":"string",
            "description":"Display name for the role."
        },
        "userAccessType":{
            "title":"userAccessType",
            "type":"string",
            "description":"User access type granted by the role."
        },
        "companyAccessType":{
            "title":"companyAccessType",
            "type":"boolean",
            "description":"Indicates whether the role grants company-level access."
        }
    },
    "description":"Application role assigned to a user or company.",
    "xml":{
        "name":"Role"
    }
}

202 Response

This Create/Modify Users job is currently in progress.

Body ()

Root Schema : UserDataStore

Type: object

Title: UserDataStore

User create, update, delete request payload and job result.

Show Source

• added: array List<UserRO>
  Title: List<UserRO>

  Users to create.
• deleted: array List<string>
  Title: List<string>

  User login IDs to delete.
• deleteFailed: array List<UserRO>
  Title: List<UserRO>

  Users that failed delete processing.
• exception: string
  Title: exception

  Error key or message returned when processing fails.
• localizedException: boolean
  Title: localizedException

  Indicates whether exception messages are localization keys.
• message: string
  Title: message

  Additional status message for the request or job.
• modified: array List<UserRO>
  Title: List<UserRO>

  Users to update.
• updatedIdMap: object updatedIdMap
  Title: updatedIdMap

  Additional Properties Allowed: additionalProperties

  Mapping of original user identifiers to updated identifiers.

{
    "title":"UserDataStore",
    "type":"object",
    "properties":{
        "added":{
            "title":"List<UserRO>",
            "type":"array",
            "description":"Users to create.",
            "items":{
                "$ref":"#/components/schemas/UserRO"
            }
        },
        "modified":{
            "title":"List<UserRO>",
            "type":"array",
            "description":"Users to update.",
            "items":{
                "$ref":"#/components/schemas/UserRO"
            }
        },
        "deleted":{
            "title":"List<string>",
            "type":"array",
            "description":"User login IDs to delete.",
            "items":{
                "type":"string"
            }
        },
        "deleteFailed":{
            "title":"List<UserRO>",
            "type":"array",
            "description":"Users that failed delete processing.",
            "items":{
                "$ref":"#/components/schemas/UserRO"
            }
        },
        "updatedIdMap":{
            "title":"updatedIdMap",
            "type":"object",
            "additionalProperties":{
                "type":"string",
                "description":"Mapping of original user identifiers to updated identifiers."
            },
            "description":"Mapping of original user identifiers to updated identifiers."
        },
        "exception":{
            "title":"exception",
            "type":"string",
            "description":"Error key or message returned when processing fails."
        },
        "message":{
            "title":"message",
            "type":"string",
            "description":"Additional status message for the request or job."
        },
        "localizedException":{
            "title":"localizedException",
            "type":"boolean",
            "description":"Indicates whether exception messages are localization keys."
        }
    },
    "description":"User create, update, delete request payload and job result."
}

Nested Schema : List<UserRO>

Type: array

Title: List<UserRO>

Users to create.

Show Source

• Array of: object UserRO
  Title: UserRO

  User record used by Cloud Administration user management APIs.

{
    "title":"List<UserRO>",
    "type":"array",
    "description":"Users to create.",
    "items":{
        "$ref":"#/components/schemas/UserRO"
    }
}

Nested Schema : List<string>

Type: array

Title: List<string>

User login IDs to delete.

Show Source

• Array of: string

{
    "title":"List<string>",
    "type":"array",
    "description":"User login IDs to delete.",
    "items":{
        "type":"string"
    }
}

Nested Schema : List<UserRO>

Type: array

Title: List<UserRO>

Users that failed delete processing.

Show Source

• Array of: object UserRO
  Title: UserRO

  User record used by Cloud Administration user management APIs.

{
    "title":"List<UserRO>",
    "type":"array",
    "description":"Users that failed delete processing.",
    "items":{
        "$ref":"#/components/schemas/UserRO"
    }
}

Nested Schema : List<UserRO>

Type: array

Title: List<UserRO>

Users to update.

Show Source

• Array of: object UserRO
  Title: UserRO

  User record used by Cloud Administration user management APIs.

{
    "title":"List<UserRO>",
    "type":"array",
    "description":"Users to update.",
    "items":{
        "$ref":"#/components/schemas/UserRO"
    }
}

Nested Schema : updatedIdMap

Type: object

Title: updatedIdMap

Additional Properties Allowed

Show Source

• string
  Mapping of original user identifiers to updated identifiers.

{
    "title":"updatedIdMap",
    "type":"object",
    "additionalProperties":{
        "type":"string",
        "description":"Mapping of original user identifiers to updated identifiers."
    },
    "description":"Mapping of original user identifiers to updated identifiers."
}

Mapping of original user identifiers to updated identifiers.

Nested Schema : UserRO

Type: object

Title: UserRO

User record used by Cloud Administration user management APIs.

Show Source

• admin: boolean
  Title: admin

  Indicates whether the user has administrator privileges.
• changePwdAtNextLogin: boolean
  Title: changePwdAtNextLogin

  Read Only: true

  Indicates whether the user must change password at next login.
• createdBy: string
  Title: createdBy

  Read Only: true

  User or process that created this record.
• createdDate: object CloudTZDateTime
  Title: CloudTZDateTime

  Read Only: true

  Date and time when the password was last reset.
• deprovisionedDate: string (date-time)
  Title: deprovisionedDate

  Read Only: true

  Date and time when the user was deprovisioned.
• deprovisioningDate: string (date-time)
  Title: deprovisioningDate

  Read Only: true

  Date and time when user deprovisioning started.
• disabled(required): boolean
  Title: disabled

  Indicates whether the user account is disabled.
• emailAddress(required): string
  Title: emailAddress

  User email address.
• employeeNumber: string
  Title: employeeNumber

  Employee number associated with the user.
• endDate: string (date-time)
  Title: endDate

  Date after which the user account is inactive.
• firstName(required): string
  Title: firstName

  User first name.
• id: string
  Title: id

  Read Only: true

  Internal user identifier.
• lastName(required): string
  Title: lastName

  User last name.
• lastPasswordResetDate: object CloudTZDateTime
  Title: CloudTZDateTime

  Read Only: true

  Date and time when the password was last reset.
• locked: boolean
  Title: locked

  Indicates whether the user account is locked.
• loginAttemptsCtr: string
  Title: loginAttemptsCtr

  Read Only: true

  Number of failed login attempts.
• loginId(required): string
  Title: loginId

  User login identifier.
• manager: string
  Title: manager

  Manager login identifier or name.
• middleName: string
  Title: middleName

  User middle name.
• organization(required): object CompanyRO
  Title: CompanyRO

  Company or organization record used by Cloud Administration APIs.
• password: string (password)
  Title: password

  Password to set for password reset operations.
• processed: boolean
  Title: processed

  Read Only: true

  Indicates whether the user record has been processed by a create or update job.
• provisionedDate: string (date-time)
  Title: provisionedDate

  Read Only: true

  Date and time when the user was provisioned.
• provisioningDate: string (date-time)
  Title: provisioningDate

  Read Only: true

  Date and time when user provisioning started.
• pwdCantChange: boolean
  Title: pwdCantChange

  Indicates whether the user is prevented from changing the password.
• pwdExpired: boolean
  Title: pwdExpired

  Read Only: true

  Indicates whether the user password has expired.
• pwdExpireDate: string (date-time)
  Title: pwdExpireDate

  Read Only: true

  Date and time when the current password expires.
• pwdWarnDate: string (date-time)
  Title: pwdWarnDate

  Read Only: true

  Date and time when password expiration warning starts.
• pwdWarned: boolean
  Title: pwdWarned

  Read Only: true

  Indicates whether the user has been warned about password expiration.
• roles: array List<RoleRO>
  Title: List<RoleRO>

  Roles assigned to the user.
• startDate: string (date-time)
  Title: startDate

  Date from which the user account is active.
• status: string
  Title: status

  User account status.
• statusInfo: string
  Title: statusInfo

  Read Only: true

  Processing status details for create or update jobs.
• statusInfoOK: boolean
  Title: statusInfoOK
• updatedDate: object CloudTZDateTime
  Title: CloudTZDateTime

  Read Only: true

  Date and time when the password was last reset.
• userType: string
  Title: userType

  User type.

{
    "title":"UserRO",
    "required":[
        "disabled",
        "emailAddress",
        "firstName",
        "lastName",
        "loginId",
        "organization"
    ],
    "type":"object",
    "properties":{
        "id":{
            "title":"id",
            "type":"string",
            "description":"Internal user identifier.",
            "readOnly":true
        },
        "status":{
            "title":"status",
            "type":"string",
            "description":"User account status."
        },
        "endDate":{
            "title":"endDate",
            "type":"string",
            "description":"Date after which the user account is inactive.",
            "format":"date-time"
        },
        "middleName":{
            "title":"middleName",
            "type":"string",
            "description":"User middle name."
        },
        "employeeNumber":{
            "title":"employeeNumber",
            "type":"string",
            "description":"Employee number associated with the user."
        },
        "firstName":{
            "title":"firstName",
            "type":"string",
            "description":"User first name."
        },
        "emailAddress":{
            "title":"emailAddress",
            "type":"string",
            "description":"User email address."
        },
        "manager":{
            "title":"manager",
            "type":"string",
            "description":"Manager login identifier or name."
        },
        "createdBy":{
            "title":"createdBy",
            "type":"string",
            "description":"User or process that created this record.",
            "readOnly":true
        },
        "lastName":{
            "title":"lastName",
            "type":"string",
            "description":"User last name."
        },
        "startDate":{
            "title":"startDate",
            "type":"string",
            "description":"Date from which the user account is active.",
            "format":"date-time"
        },
        "locked":{
            "title":"locked",
            "type":"boolean",
            "description":"Indicates whether the user account is locked."
        },
        "pwdExpireDate":{
            "title":"pwdExpireDate",
            "type":"string",
            "description":"Date and time when the current password expires.",
            "format":"date-time",
            "readOnly":true
        },
        "updatedDate":{
            "$ref":"#/components/schemas/CloudTZDateTime"
        },
        "createdDate":{
            "$ref":"#/components/schemas/CloudTZDateTime"
        },
        "pwdWarnDate":{
            "title":"pwdWarnDate",
            "type":"string",
            "description":"Date and time when password expiration warning starts.",
            "format":"date-time",
            "readOnly":true
        },
        "provisionedDate":{
            "title":"provisionedDate",
            "type":"string",
            "description":"Date and time when the user was provisioned.",
            "format":"date-time",
            "readOnly":true
        },
        "disabled":{
            "title":"disabled",
            "type":"boolean",
            "description":"Indicates whether the user account is disabled."
        },
        "roles":{
            "title":"List<RoleRO>",
            "type":"array",
            "description":"Roles assigned to the user.",
            "items":{
                "$ref":"#/components/schemas/RoleRO"
            }
        },
        "organization":{
            "$ref":"#/components/schemas/CompanyRO"
        },
        "pwdCantChange":{
            "title":"pwdCantChange",
            "type":"boolean",
            "description":"Indicates whether the user is prevented from changing the password."
        },
        "pwdWarned":{
            "title":"pwdWarned",
            "type":"boolean",
            "description":"Indicates whether the user has been warned about password expiration.",
            "readOnly":true
        },
        "processed":{
            "title":"processed",
            "type":"boolean",
            "description":"Indicates whether the user record has been processed by a create or update job.",
            "readOnly":true
        },
        "pwdExpired":{
            "title":"pwdExpired",
            "type":"boolean",
            "description":"Indicates whether the user password has expired.",
            "readOnly":true
        },
        "userType":{
            "title":"userType",
            "type":"string",
            "description":"User type."
        },
        "statusInfo":{
            "title":"statusInfo",
            "type":"string",
            "description":"Processing status details for create or update jobs.",
            "readOnly":true
        },
        "admin":{
            "title":"admin",
            "type":"boolean",
            "description":"Indicates whether the user has administrator privileges."
        },
        "loginId":{
            "title":"loginId",
            "type":"string",
            "description":"User login identifier."
        },
        "statusInfoOK":{
            "title":"statusInfoOK",
            "type":"boolean"
        },
        "password":{
            "title":"password",
            "type":"string",
            "description":"Password to set for password reset operations.",
            "format":"password",
            "writeOnly":true
        },
        "lastPasswordResetDate":{
            "$ref":"#/components/schemas/CloudTZDateTime"
        },
        "provisioningDate":{
            "title":"provisioningDate",
            "type":"string",
            "description":"Date and time when user provisioning started.",
            "format":"date-time",
            "readOnly":true
        },
        "deprovisioningDate":{
            "title":"deprovisioningDate",
            "type":"string",
            "description":"Date and time when user deprovisioning started.",
            "format":"date-time",
            "readOnly":true
        },
        "deprovisionedDate":{
            "title":"deprovisionedDate",
            "type":"string",
            "description":"Date and time when the user was deprovisioned.",
            "format":"date-time",
            "readOnly":true
        },
        "changePwdAtNextLogin":{
            "title":"changePwdAtNextLogin",
            "type":"boolean",
            "description":"Indicates whether the user must change password at next login.",
            "readOnly":true
        },
        "loginAttemptsCtr":{
            "title":"loginAttemptsCtr",
            "type":"string",
            "description":"Number of failed login attempts.",
            "readOnly":true
        }
    },
    "description":"User record used by Cloud Administration user management APIs.",
    "xml":{
        "name":"User"
    }
}

Nested Schema : CloudTZDateTime

Type: object

Title: CloudTZDateTime

Read Only: true

Date and time when the password was last reset.

Show Source

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

{
    "title":"CloudTZDateTime",
    "type":"object",
    "properties":{
        "millis":{
            "title":"millis",
            "type":"integer",
            "format":"int64"
        },
        "wrappedDateTime":{
            "title":"wrappedDateTime",
            "type":"string",
            "format":"date-time"
        }
    },
    "description":"Date and time when the password was last reset.",
    "readOnly":true
}

Nested Schema : CompanyRO

Type: object

Title: CompanyRO

Company or organization record used by Cloud Administration APIs.

Show Source

• associations: array List<string>
  Title: List<string>

  Unique Items Required: true

  Role or product associations for the company.
• bidderCompany: boolean
  Title: bidderCompany

  Indicates whether the company is a bidder company.
• createdBy: string
  Title: createdBy

  Read Only: true

  User or process that created the company.
• createdDate: string (date-time)
  Title: createdDate

  Read Only: true

  Date and time when the company was created.
• displayName(required): string
  Title: displayName

  Display name for the company.
• id(required): string
  Title: id

  Internal company identifier.
• inheritedPolicy: boolean
  Title: inheritedPolicy

  Indicates whether the password policy is inherited from a parent company.
• isDeletable: boolean
  Title: isDeletable

  Read Only: true

  Indicates whether the company can be deleted.
• name(required): string
  Title: name

  Company name.
• parentId: string
  Title: parentId

  Identifier of the parent company.
• parentName: string
  Title: parentName

  Name of the parent company.
• processed: boolean
  Title: processed

  Read Only: true

  Indicates whether the company record has been processed.
• pwdPolicy: object ShortPasswordPolicyRO
  Title: ShortPasswordPolicyRO

  Summary password policy associated with a company.
• status: string
  Title: status

  Company status.
• statusInfo: string
  Title: statusInfo

  Read Only: true

  Processing status details for create or update requests.
• type: string
  Title: type

  Company type.
• updatedBy: string
  Title: updatedBy

  Read Only: true

  User or process that last updated the company.
• updatedDate: string (date-time)
  Title: updatedDate

  Read Only: true

  Date and time when the company was last updated.

{
    "title":"CompanyRO",
    "required":[
        "displayName",
        "id",
        "name"
    ],
    "type":"object",
    "properties":{
        "pwdPolicy":{
            "$ref":"#/components/schemas/ShortPasswordPolicyRO"
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"Company name."
        },
        "id":{
            "title":"id",
            "type":"string",
            "description":"Internal company identifier."
        },
        "type":{
            "title":"type",
            "type":"string",
            "description":"Company type."
        },
        "displayName":{
            "title":"displayName",
            "type":"string",
            "description":"Display name for the company."
        },
        "status":{
            "title":"status",
            "type":"string",
            "description":"Company status."
        },
        "createdBy":{
            "title":"createdBy",
            "type":"string",
            "description":"User or process that created the company.",
            "readOnly":true
        },
        "updatedDate":{
            "title":"updatedDate",
            "type":"string",
            "description":"Date and time when the company was last updated.",
            "format":"date-time",
            "readOnly":true
        },
        "createdDate":{
            "title":"createdDate",
            "type":"string",
            "description":"Date and time when the company was created.",
            "format":"date-time",
            "readOnly":true
        },
        "processed":{
            "title":"processed",
            "type":"boolean",
            "description":"Indicates whether the company record has been processed.",
            "readOnly":true
        },
        "statusInfo":{
            "title":"statusInfo",
            "type":"string",
            "description":"Processing status details for create or update requests.",
            "readOnly":true
        },
        "parentId":{
            "title":"parentId",
            "type":"string",
            "description":"Identifier of the parent company."
        },
        "updatedBy":{
            "title":"updatedBy",
            "type":"string",
            "description":"User or process that last updated the company.",
            "readOnly":true
        },
        "parentName":{
            "title":"parentName",
            "type":"string",
            "description":"Name of the parent company."
        },
        "inheritedPolicy":{
            "title":"inheritedPolicy",
            "type":"boolean",
            "description":"Indicates whether the password policy is inherited from a parent company."
        },
        "associations":{
            "title":"List<string>",
            "uniqueItems":true,
            "type":"array",
            "description":"Role or product associations for the company.",
            "items":{
                "type":"string",
                "description":"Role or product associations for the company.",
                "xml":{
                    "name":"associations"
                }
            }
        },
        "isDeletable":{
            "title":"isDeletable",
            "type":"boolean",
            "description":"Indicates whether the company can be deleted.",
            "readOnly":true
        },
        "bidderCompany":{
            "title":"bidderCompany",
            "type":"boolean",
            "description":"Indicates whether the company is a bidder company."
        }
    },
    "description":"Company or organization record used by Cloud Administration APIs.",
    "xml":{
        "name":"Organization"
    }
}

Nested Schema : List<RoleRO>

Type: array

Title: List<RoleRO>

Roles assigned to the user.

Show Source

• Array of: object RoleRO
  Title: RoleRO

  Application role assigned to a user or company.

{
    "title":"List<RoleRO>",
    "type":"array",
    "description":"Roles assigned to the user.",
    "items":{
        "$ref":"#/components/schemas/RoleRO"
    }
}

Nested Schema : List<string>

Type: array

Title: List<string>

Unique Items Required: true

Role or product associations for the company.

Show Source

• Array of: string
  Role or product associations for the company.

{
    "title":"List<string>",
    "uniqueItems":true,
    "type":"array",
    "description":"Role or product associations for the company.",
    "items":{
        "type":"string",
        "description":"Role or product associations for the company.",
        "xml":{
            "name":"associations"
        }
    }
}

Nested Schema : ShortPasswordPolicyRO

Type: object

Title: ShortPasswordPolicyRO

Summary password policy associated with a company.

Show Source

• id: string
  Title: id

  Password policy identifier.
• name(required): string
  Title: name

  Password policy name.

{
    "title":"ShortPasswordPolicyRO",
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "title":"name",
            "type":"string",
            "description":"Password policy name."
        },
        "id":{
            "title":"id",
            "type":"string",
            "description":"Password policy identifier."
        }
    },
    "description":"Summary password policy associated with a company.",
    "xml":{
        "name":"PwdPolicy"
    }
}

Nested Schema : RoleRO

Type: object

Title: RoleRO

Application role assigned to a user or company.

Show Source

• companyAccessType: boolean
  Title: companyAccessType

  Indicates whether the role grants company-level access.
• displayName: string
  Title: displayName

  Display name for the role.
• id: string
  Title: id

  Read Only: true

  Internal role identifier.
• name(required): string
  Title: name

  Role name.
• userAccessType: string
  Title: userAccessType

  User access type granted by the role.

{
    "title":"RoleRO",
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "title":"name",
            "type":"string",
            "description":"Role name."
        },
        "id":{
            "title":"id",
            "type":"string",
            "description":"Internal role identifier.",
            "readOnly":true
        },
        "displayName":{
            "title":"displayName",
            "type":"string",
            "description":"Display name for the role."
        },
        "userAccessType":{
            "title":"userAccessType",
            "type":"string",
            "description":"User access type granted by the role."
        },
        "companyAccessType":{
            "title":"companyAccessType",
            "type":"boolean",
            "description":"Indicates whether the role grants company-level access."
        }
    },
    "description":"Application role assigned to a user or company.",
    "xml":{
        "name":"Role"
    }
}

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