Patch Org

Patch Org

Use this API instead:

  • /cloudapi/1.0.0/orgs

NOTE: At the moment we only allow for displayName change.

Access Policy

Role Access
Platform operator ✔️
Organization Owner ✔️
Organization Member ❌
Service Account (Whitelisted Client) ❌
Request
URI
PATCH
https://vra-interop-222-139.lvn.broadcom.net/csp/gateway/am/api/orgs/{orgId}
COPY
Path Parameters
string
orgId
Required

orgId

Request Body
OrganizationResponse of type(s) application/json
Required 
{
    "name": "string",
    "displayName": "string",
    "metadata": {
        "metadata": "string"
    },
    "id": "string",
    "refLink": "string",
    "parentRefLink": "string"
}
string
name
Optional

name

string
displayName
Optional

displayName

object
metadata
Optional

metadata

string
id
Optional

id

string
refLink
Optional

refLink

string
parentRefLink
Optional

parentRefLink

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns RefLink of type(s) */* 
"RefLink Object"
string
refLink
Optional

refLink


400

Invalid request body.

Returns RefLink of type(s) */* 
"RefLink Object"
string
refLink
Optional

refLink


401

The user is not authorized to use the API.

Returns RefLink of type(s) */* 
"RefLink Object"
string
refLink
Optional

refLink


Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
Deprecated
On This Page
Organization Controller Operations
GET
Get By Id
Deprecated
PATCH
Patch Org
Deprecated
GET
Get Org Roles
Deprecated
PATCH
Patch Org Roles
Deprecated
GET
Get Org Sub Orgs
Deprecated
GET
Get Role By Org Id And Role Id
Deprecated
GET
Search Org Groups
Deprecated