Remove Share Pinboard

Remove Share Pinboard

Share Pinboard with users and LDAP/vIDM groups. Only admin and member users can perform this action

Request
URI
PUT
https://www.mgmt.cloud.vmware.com/ni/api/ni/pinboards/{id}/remove-share
COPY
Path Parameters
string
id
Required

The Entity ID of object requestion information on


Request Body

Remove pinboard share for given users and groups

SharePinboardRequest of type(s) application/json
Required
{
    "users_read_access": [
        "[email protected]",
        "[email protected]"
    ],
    "users_write_access": [
        "[email protected]",
        "[email protected]"
    ],
    "groups_read_access": [
        "CN=Dev,CN=Users,DC=vrni,DC=com"
    ],
    "groups_write_access": [
        "CN=HR,CN=Users,DC=vrni,DC=com"
    ]
}
array of string
users_read_access
Optional

List of users with read privilege for the pinboard

array of string
users_write_access
Optional

List of users with all privileges for the pinboard

array of string
groups_read_access
Optional

List of groups with read privilege for the pinboard

array of string
groups_write_access
Optional

List of groups with read and write privilege for the pinboard

Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns PinboardResponse of type(s) application/json
{
    "id": "18799:10002:211561153588",
    "name": "Pinboard Name",
    "description": "This is the pinboard description",
    "create_timestamp": 156789876,
    "last_updated_timestamp": 156789876,
    "owner": "admin@local",
    "users_read_access": [
        "[email protected]",
        "[email protected]"
    ],
    "users_write_access": [
        "[email protected]",
        "[email protected]"
    ],
    "pins": [
        {
            "id": "1000:10001:78690089",
            "name": "Pin Name",
            "query": "Alert where Severity = 'Critical'"
        }
    ],
    "groups_write_access": [
        "CN=HR,CN=Users"
    ],
    "groups_read_access": [
        "cn=administrators"
    ]
}
string
id
Optional

Entity Identifier for a pinboard

string
name
Optional

Descriptor or identifier for particular pinboard.

string
description
Optional

Description of the pinboard

string
create_timestamp
Optional

Create timestamp for pinboard

string
last_updated_timestamp
Optional

Last update timestamp for pinboard

string
owner
Optional

User email of the pinboard owner

array of string
users_read_access
Optional

List of users with read privilege for the pinboard

array of string
users_write_access
Optional

List of users with read and write privilege for the pinboard

pins
Optional

Pins associated with Pinboard

array of string
groups_write_access
Optional

LDAP/VIDM groups with read and write privilege of the pinboard

array of string
groups_read_access
Optional

LDAP/VIDM groups with read privilege of the pinboard


400

Bad Request

Returns ApiError of type(s) application/json
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

details
Optional

details


401

Unauthorized

Returns ApiError of type(s) application/json
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

details
Optional

details


500

Internal Error

Returns ApiError of type(s) application/json
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

details
Optional

details