Patch

/localproviders/{id}/

This endpoint modifies a specified local provider.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Path parameters

id

integerRequired

VAST Provider ID

Minimum1

Body parameters

object

name

string

Name of the local provider

description

string

Description of the local provider

managed_by

Array of string

Manager user types that can manage the provider

string

Valid values[ "TENANT_ADMIN", "SUPER_ADMIN" ]

Responses

200

object

id

integer

name

string

Name of the local provider

description

string

Description of the local provider

managed_by

Array of string

Specifies which manager user types have permission to manage users and groups on the provider. SUPER_ADMIN refers to VMS manager users with user type 'cluster admin' who can log into the cluster VMS to manage the cluster. TENANT_ADMIN refers VMS manager users with 'tenant admin' type who can log into a specific tenant's VMS to manage that tenant. Either both or one or the other may be specified.

string

Valid values[ "TENANT_ADMIN", "SUPER_ADMIN" ]

assigned_tenants_preview

string

Modify a Local Provider