Skip to content

Assign role to User.

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

AssignRole allows customers to assign a namespace/role pair to multiple users.

Examples of this operation.

namespace
required
string

Namespace Namespace the requesting user is calling the action from.

Media typeapplication/json
Assign role

Allows assigning user’s role in a namespace or set of namespaces.

object
namespace
Namespace

Namespace the requesting user is calling the action from.

string
>= 6 characters <= 1024 characters
namespaces_role
object
namespaces
Namespaces

Namespace, including star (*) which means all tenant’s namespaces.

Array<string>
role
Role

Users role for this namespace.

string
<= 1024 characters
username
Username

Username of the user that needs the role assigned. Ideally this will be the email address of the user (which is by default treated as username) check Create RPC UserRoleRequest for more details.

Array<string>
Examplegenerated
{
"namespace": "example",
"namespaces_role": {
"namespaces": [
"example"
],
"role": "example"
},
"username": [
"example"
]
}

A successful response.

Media typeapplication/json
Empty

Empty is a message without actual content/body.

object
Examplegenerated
{}

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