Jump to

• Request
• Response

Create/Update Company

post

/cloudapi/restapi/v3/user/companies/add-list

This operation enables you to create and modify Company records. The operation creates a company if a matching company does not exist in the system or modifies the company if a match is found. Any new roles provided under the roles attribute are provisioned for the company by the operation. If successful, this operation returns a company data store containing processed records and status information.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : CompanyDataStore

Type: object

Title: CompanyDataStore

Company create, update, delete request payload and result.

Show Source

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

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

  Company identifiers to delete.
• deleteFailed: array List<CompanyRO>
  Title: List<CompanyRO>

  Companies 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.
• modified: array List<CompanyRO>
  Title: List<CompanyRO>

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

  Additional Properties Allowed: additionalProperties

  Mapping of original company identifiers to updated identifiers.

{
    "title":"CompanyDataStore",
    "type":"object",
    "properties":{
        "added":{
            "title":"List<CompanyRO>",
            "type":"array",
            "description":"Companies to create.",
            "items":{
                "$ref":"#/components/schemas/CompanyRO"
            }
        },
        "modified":{
            "title":"List<CompanyRO>",
            "type":"array",
            "description":"Companies to update.",
            "items":{
                "$ref":"#/components/schemas/CompanyRO"
            }
        },
        "deleted":{
            "title":"List<string>",
            "type":"array",
            "description":"Company identifiers to delete.",
            "items":{
                "type":"string"
            }
        },
        "deleteFailed":{
            "title":"List<CompanyRO>",
            "type":"array",
            "description":"Companies that failed delete processing.",
            "items":{
                "$ref":"#/components/schemas/CompanyRO"
            }
        },
        "updatedIdMap":{
            "title":"updatedIdMap",
            "type":"object",
            "additionalProperties":{
                "type":"string",
                "description":"Mapping of original company identifiers to updated identifiers."
            },
            "description":"Mapping of original company 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."
        },
        "localizedException":{
            "title":"localizedException",
            "type":"boolean",
            "description":"Indicates whether exception messages are localization keys."
        }
    },
    "description":"Company create, update, delete request payload and result."
}

Nested Schema : List<CompanyRO>

Type: array

Title: List<CompanyRO>

Companies to create.

Show Source

• Array of: object CompanyRO
  Title: CompanyRO

  Company or organization record used by Cloud Administration APIs.

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

Nested Schema : List<string>

Type: array

Title: List<string>

Company identifiers to delete.

Show Source

• Array of: string

{
    "title":"List<string>",
    "type":"array",
    "description":"Company identifiers to delete.",
    "items":{
        "type":"string"
    }
}

Nested Schema : List<CompanyRO>

Type: array

Title: List<CompanyRO>

Companies that failed delete processing.

Show Source

• Array of: object CompanyRO
  Title: CompanyRO

  Company or organization record used by Cloud Administration APIs.

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

Nested Schema : List<CompanyRO>

Type: array

Title: List<CompanyRO>

Companies to update.

Show Source

• Array of: object CompanyRO
  Title: CompanyRO

  Company or organization record used by Cloud Administration APIs.

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

Nested Schema : updatedIdMap

Type: object

Title: updatedIdMap

Additional Properties Allowed

Show Source

• string
  Mapping of original company identifiers to updated identifiers.

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

Mapping of original company identifiers to updated identifiers.

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

Examples

Select an example Create company Modify company

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : CompanyDataStore

Type: object

Title: CompanyDataStore

Company create, update, delete request payload and result.

Show Source

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

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

  Company identifiers to delete.
• deleteFailed: array List<CompanyRO>
  Title: List<CompanyRO>

  Companies 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.
• modified: array List<CompanyRO>
  Title: List<CompanyRO>

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

  Additional Properties Allowed: additionalProperties

  Mapping of original company identifiers to updated identifiers.

{
    "title":"CompanyDataStore",
    "type":"object",
    "properties":{
        "added":{
            "title":"List<CompanyRO>",
            "type":"array",
            "description":"Companies to create.",
            "items":{
                "$ref":"#/components/schemas/CompanyRO"
            }
        },
        "modified":{
            "title":"List<CompanyRO>",
            "type":"array",
            "description":"Companies to update.",
            "items":{
                "$ref":"#/components/schemas/CompanyRO"
            }
        },
        "deleted":{
            "title":"List<string>",
            "type":"array",
            "description":"Company identifiers to delete.",
            "items":{
                "type":"string"
            }
        },
        "deleteFailed":{
            "title":"List<CompanyRO>",
            "type":"array",
            "description":"Companies that failed delete processing.",
            "items":{
                "$ref":"#/components/schemas/CompanyRO"
            }
        },
        "updatedIdMap":{
            "title":"updatedIdMap",
            "type":"object",
            "additionalProperties":{
                "type":"string",
                "description":"Mapping of original company identifiers to updated identifiers."
            },
            "description":"Mapping of original company 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."
        },
        "localizedException":{
            "title":"localizedException",
            "type":"boolean",
            "description":"Indicates whether exception messages are localization keys."
        }
    },
    "description":"Company create, update, delete request payload and result."
}

Nested Schema : List<CompanyRO>

Type: array

Title: List<CompanyRO>

Companies to create.

Show Source

• Array of: object CompanyRO
  Title: CompanyRO

  Company or organization record used by Cloud Administration APIs.

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

Nested Schema : List<string>

Type: array

Title: List<string>

Company identifiers to delete.

Show Source

• Array of: string

{
    "title":"List<string>",
    "type":"array",
    "description":"Company identifiers to delete.",
    "items":{
        "type":"string"
    }
}

Nested Schema : List<CompanyRO>

Type: array

Title: List<CompanyRO>

Companies that failed delete processing.

Show Source

• Array of: object CompanyRO
  Title: CompanyRO

  Company or organization record used by Cloud Administration APIs.

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

Nested Schema : List<CompanyRO>

Type: array

Title: List<CompanyRO>

Companies to update.

Show Source

• Array of: object CompanyRO
  Title: CompanyRO

  Company or organization record used by Cloud Administration APIs.

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

Nested Schema : updatedIdMap

Type: object

Title: updatedIdMap

Additional Properties Allowed

Show Source

• string
  Mapping of original company identifiers to updated identifiers.

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

Mapping of original company identifiers to updated identifiers.

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

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