Skip to content
API Enriched

Replace VoltShare Admin Policy.

PUT
/api/secret_management/namespaces/{metadata.namespace}/voltshare_admin_policys/{metadata.name}
curl --request PUT \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/secret_management/namespaces/example/voltshare_admin_policys/example \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "metadata": { "annotations": {}, "description": "example", "disable": true, "labels": {}, "name": "example", "namespace": "example" }, "spec": { "author_restrictions": { "allow_all": {}, "allow_list": { "custom_list": [ { "exact_value": "example", "regex_pattern": "example" } ] }, "deny_all": {}, "deny_list": { "custom_list": [ { "exact_value": "example", "regex_pattern": "example" } ] } }, "max_validity_duration": "example", "user_restrictions": [ { "all_tenants": {}, "individual_users": {}, "tenant": "example", "user_restrictions": { "allow_all": {}, "allow_list": { "custom_list": [ { "exact_value": "example", "regex_pattern": "example" } ] }, "deny_all": {}, "deny_list": { "custom_list": [ { "exact_value": "example", "regex_pattern": "example" } ] } } } ] } }'

Replace voltshare_admin_policy replaces an existing object in the storage backend for metadata.namespace.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
metadata.namespace
required
string

Namespace This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

metadata.name
required
string

Name The configuration object to be replaced will be looked up by name.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ReplaceRequest is used to replace contents of a voltshare_admin_policy

This is the input message of the ‘Replace’ RPC.

object
metadata
object
annotations
annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

object
description
description

Human readable description for the object.

string
>= 21 characters <= 1200 characters
disable
disable

A value of true will administratively disable the object.

boolean format: boolean
labels
labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.

object
name
name

This is the name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API. The value of name has to follow DNS-1035 format. Required: YES.

string
>= 6 characters <= 1024 characters
namespace
namespace

This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

string
>= 6 characters <= 1024 characters
spec
object
author_restrictions
object
allow_all
object
allow_list
object
custom_list
List of User Id(s)

List of user ID(s)

Array<object>
<= 16 items
MatcherType

MatcherType contains the choice of value to be compared against the input userid. It could be a regex pattern or exact value.

object
exact_value
exact_match

Exclusive with [regex_pattern] exact_match contains user_id to match against.

string
>= 1 characters <= 256 characters
regex_pattern
regex_values

Exclusive with [exact_value] regex_values contains a regex pattern to match against.

string
>= 1 characters <= 256 characters
deny_all
object
deny_list
object
custom_list
List of User Id(s)

List of user ID(s)

Array<object>
<= 16 items
MatcherType

MatcherType contains the choice of value to be compared against the input userid. It could be a regex pattern or exact value.

object
exact_value
exact_match

Exclusive with [regex_pattern] exact_match contains user_id to match against.

string
>= 1 characters <= 256 characters
regex_pattern
regex_values

Exclusive with [exact_value] regex_values contains a regex pattern to match against.

string
>= 1 characters <= 256 characters
max_validity_duration

Max_validity_duration contains the maximum amount of time a secret from any users from this team/tenant is valid. Value for this parameter is a string ending in the suffix “s” (indicating seconds), suffix “m” (indicating minutes) or suffix “h” (indicating hours)

string
<= 1024 characters
user_restrictions

User_restrictions contains per tenant/team list of allowed/disallowed users with whom a secret can be shared using F5XC VoltShare.

Array<object>
<= 16 items
UserRestrictionType

User_restrictions contains list of allowed/disallowed users with whom a secret can be shared using F5XC VoltShare for any given team/tenant.

object
all_tenants
object
individual_users
object
tenant
tenant

Exclusive with [all_tenants individual_users] Team/Tenant for which this rule is valid.

string
>= 1 characters <= 256 characters
user_restrictions
object
allow_all
object
allow_list
object
custom_list
List of User Id(s)

List of user ID(s)

Array<object>
<= 16 items
MatcherType

MatcherType contains the choice of value to be compared against the input userid. It could be a regex pattern or exact value.

object
exact_value
exact_match

Exclusive with [regex_pattern] exact_match contains user_id to match against.

string
>= 1 characters <= 256 characters
regex_pattern
regex_values

Exclusive with [exact_value] regex_values contains a regex pattern to match against.

string
>= 1 characters <= 256 characters
deny_all
object
deny_list
object
custom_list
List of User Id(s)

List of user ID(s)

Array<object>
<= 16 items
MatcherType

MatcherType contains the choice of value to be compared against the input userid. It could be a regex pattern or exact value.

object
exact_value
exact_match

Exclusive with [regex_pattern] exact_match contains user_id to match against.

string
>= 1 characters <= 256 characters
regex_pattern
regex_values

Exclusive with [exact_value] regex_values contains a regex pattern to match against.

string
>= 1 characters <= 256 characters
Examplegenerated
{
  "metadata": {
    "annotations": {},
    "description": "example",
    "disable": true,
    "labels": {},
    "name": "example",
    "namespace": "example"
  },
  "spec": {
    "author_restrictions": {
      "allow_all": {},
      "allow_list": {
        "custom_list": [
          {
            "exact_value": "example",
            "regex_pattern": "example"
          }
        ]
      },
      "deny_all": {},
      "deny_list": {
        "custom_list": [
          {
            "exact_value": "example",
            "regex_pattern": "example"
          }
        ]
      }
    },
    "max_validity_duration": "example",
    "user_restrictions": [
      {
        "all_tenants": {},
        "individual_users": {},
        "tenant": "example",
        "user_restrictions": {
          "allow_all": {},
          "allow_list": {
            "custom_list": [
              {
                "exact_value": "example",
                "regex_pattern": "example"
              }
            ]
          },
          "deny_all": {},
          "deny_list": {
            "custom_list": [
              {
                "exact_value": "example",
                "regex_pattern": "example"
              }
            ]
          }
        }
      }
    ]
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
object
Examplegenerated
{}

401

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example