Update Broker Directory

Update Broker Directory

VMware Identity Services API to update a directory with a specific id.

Request
URI
PATCH
https://{api_host}//usergroup/t/{TENANT}/broker/directories/{id}
COPY
Path Parameters
string
id
Required

Id of the directory.

string
TENANT
Required

TENANT


Request Body
BrokerDirectoryMedia of type(s) application/vnd.vmware.vidm.usergroup.broker.directory+json
Required
{
    "_links": {
        "self": {
            "href": "https://example.com/path-to-self"
        }
    },
    "id": "string",
    "name": "string",
    "domains": [
        "string"
    ],
    "default_domain": "string",
    "source": "AZURE",
    "type": "PROVISIONED",
    "delete_in_progress": false
}
object
_links
Optional

The resource HATEOAS links. Usually includes a "self" link for this resource

string As uuid As uuid
id
Optional

Uniquely identifies the directory in APIs

string As ^[\p{L}0-9-_. ]*$
name
Required

User provided directory name. This must be unique. The allowed symbols are letters, digits (0-9), space and -_.

array of string
domains
Required

List of directory domain names.

string
default_domain
Optional

The default domain name that is used when the domain name is not synced from the external directory. Must be one of the list of domain names. Note that the field is not returned in list directories API.

string
source
Optional

The type of the directory source

Possible values are : AZURE, PING, OKTA, GENERIC,
string
type
Optional

The directory type

Possible values are : PROVISIONED, JIT,
boolean
delete_in_progress
Optional

If true, the directory is marked for deletion and it will be deleted soon.

Authentication
This operation uses the following authentication methods.
Responses
200

Directory is updated.

Returns BrokerDirectoryMedia of type(s) application/vnd.vmware.vidm.usergroup.broker.directory+json
{
    "_links": {
        "self": {
            "href": "https://example.com/path-to-self"
        }
    },
    "id": "string",
    "name": "string",
    "domains": [
        "string"
    ],
    "default_domain": "string",
    "source": "AZURE",
    "type": "PROVISIONED",
    "delete_in_progress": false
}
object
_links
Optional

The resource HATEOAS links. Usually includes a "self" link for this resource

string As uuid As uuid
id
Optional

Uniquely identifies the directory in APIs

string As ^[\p{L}0-9-_. ]*$
name
Required

User provided directory name. This must be unique. The allowed symbols are letters, digits (0-9), space and -_.

array of string
domains
Required

List of directory domain names.

string
default_domain
Optional

The default domain name that is used when the domain name is not synced from the external directory. Must be one of the list of domain names. Note that the field is not returned in list directories API.

string
source
Optional

The type of the directory source

Possible values are : AZURE, PING, OKTA, GENERIC,
string
type
Optional

The directory type

Possible values are : PROVISIONED, JIT,
boolean
delete_in_progress
Optional

If true, the directory is marked for deletion and it will be deleted soon.


400

The directory input is invalid.

Operation doesn't return any data structure

401

Unauthorized to update the directory.

Operation doesn't return any data structure

403

Forbidden to read the directory.

Operation doesn't return any data structure

404

The directory was not found in the system.

Operation doesn't return any data structure

409

The directory or domain name already exists, no Sync Client Configurations was found for the directory, or more than one Sync Client Configurations was found for the directory.

Operation doesn't return any data structure