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 an accepted status (202) with a location header pointing to a jobId status. The operation is complete when the jobId status returns OK (200). The previous create user operation must complete before another create company operation is allowed.

Request

Supported Media Types

• application/json

Body ()

Root Schema : RestDataStoreCompanyRO

Type: object

Show Source

• added: array added
• deleted: array deleted
• deleteFailed: array deleteFailed
• exception: string
• localizedException: boolean
• message: string
• modified: array modified
• updatedIdMap: object updatedIdMap
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "added":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CompanyRO"
            }
        },
        "modified":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CompanyRO"
            }
        },
        "deleted":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "deleteFailed":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CompanyRO"
            }
        },
        "message":{
            "type":"string"
        },
        "exception":{
            "type":"string"
        },
        "updatedIdMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "localizedException":{
            "type":"boolean"
        }
    }
}

Nested Schema : added

Type: array

Show Source

• Array of: object Organization

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CompanyRO"
    }
}

Nested Schema : deleted

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : deleteFailed

Type: array

Show Source

• Array of: object Organization

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CompanyRO"
    }
}

Nested Schema : modified

Type: array

Show Source

• Array of: object Organization

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CompanyRO"
    }
}

Nested Schema : updatedIdMap

Type: object

Additional Properties Allowed

Show Source

• string

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

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : schema

Type: file

202 Response

Create/Modify Company request has been accepted and currently in progress.

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