Skip to content

Create/RE-create SCIM API token.

POST
/api/web/namespaces/{namespace}/scim_token
curl --request POST \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/namespaces/example/scim_token \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "expiration_days": 1, "namespace": "example" }'

Request to create/RE-create new SCIM API credential. Note: Only one valid (non-expired) SCIM token could exist for a tenant, and only if SCIM is enabled for the tenant. If a valid SCIM token is already minted, we would revoke the current one and generate a new one.

Examples of this operation.

namespace
required
string

Namespace Value of namespace is always “system”.

Media typeapplication/json
Recreate SCIM Token Request

RecreateScimTokenRequest is the request format for generating SCIM API credential.

object
expiration_days
Expiry in days

Qty of days of service credential expiration. Default value is 180. Expiration days value can range between 1 and 730.

integer format: int64
namespace
Namespace

Value of namespace is always “system”.

string
>= 6 characters <= 1024 characters
Examplegenerated
{
"expiration_days": 1,
"namespace": "example"
}

A successful response.

Media typeapplication/json
Create response

CreateResponse is the response format for the credential’s create request.

object
active

Indicates if the resource is active

boolean format: boolean
data
Credentials

Data is the response format based on the API credential type. In case of API_CERTIFICATES, the response is the base64 encoded value of certificate in PKCS12 format. In case of KUBE_CONFIG, the response is the base64 encoded value of the K8s kubeconfig file with contents as requested - cluster,namespace and base64 encoded certificate, key and CA.

string
<= 1024 characters
expiration_timestamp

Configuration parameter for expiration timestamp

string format: date-time
<= 1024 characters
name

Human-readable name for the resource

string
>= 6 characters <= 1024 characters
Examplegenerated
{
"active": true,
"data": "example",
"expiration_timestamp": "2026-04-15T12:00:00Z",
"name": "example"
}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

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

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example