Post

/users/

This endpoint adds a user to a VAST 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 .

Body parameters

Expand All

object

name

string Required

User name

uid

integer

NFS UID

leading_gid

integer

Leading GID

gids

Array of integer

List of group GIDs of all groups to which the user should belong.

integer

local

boolean

Not in use

allow_create_bucket

boolean

Set to true to give the user permission to create S3 buckets. In case of conflict with an S3 identity policy attached to the user or to a relevant group, this setting is overridden.

allow_delete_bucket

boolean

Set to true to give the user permission to delete S3 buckets. In case of conflict with an S3 identity policy attached to the user or to a relevant group, this setting is overridden.

s3_superuser

boolean

Set to true to give the user S3 superuser permission. In case of conflict with an S3 identity policy attached to the user or to a relevant group, this setting is overridden.

s3_policies_ids

object

Specify S3 policies to attach to the user.

password

string

Password

local_provider_id

integer

The ID of the VAST provider to which to add the user

Responses

201

User details

Expand All

object

id

integer

guid

string

Global unique ID

name

string

The name of the user

url

string

Endpoint URL for API operations on the user

title

string

vid

integer

User's VAST ID

uid

integer

UID

leading_gid

integer

Leading GID

gids

Array of integer

List of GIDs of groups to which the user belongs

integer

groups

Array of string

List of groups to which the user belongs

string

group_count

integer

Group Count

leading_group_name

string

Leading Group

leading_group_gid

integer

Leading Group GID

sid

string

SID

primary_group_sid

string

Primary group SID

sids

Array of string

SID list

string

local

boolean

not in use

access_keys

Array of object

S3 Access Keys

object

allow_create_bucket

boolean

If enabled, the user has permission to create S3 buckets. In case of conflict with an S3 identity policy attached to the user or to a elevant group, this setting is overridden.

allow_delete_bucket

boolean

If enabled, the user has permission to delete S3 buckets. In case of conflict with an S3 identity policy attached to the user or to a relevant group, this setting is overridden

s3_superuser

boolean

If enabled, the user has S3 superuser permission, which overrides S3 ACLs. In case of conflict with an S3 identity policy attached to the user or to a relevant group, this setting is overridden.

s3_policies_ids

Array of integer

S3 policies IDs, denoting which S3 identity policies are associated with the user. The user is granted and denied S3 permissions according to the associated S3 identity policies

integer

s3_policies

Array of object (PartialS3PolicyInfo)

object

id

integer

Identity Policy ID

name

string

Identity Policy name

local_provider

object (LocalProviderData)

id

integer

ID of the local provider

name

string

Name of the local provider

is_temporary_password

boolean

Password is temporary

password_is_set

boolean

Password is set

Add User to a VAST Provider