IRPCNamedACLsAdmin.AddNamedACL

Administration API / specialized admin session

Adds a named ACL to the vault.

Service	Named access control list administration `MFiles.IRPCNamedACLsAdmin`
gRPC method	`/MFiles.IRPCNamedACLsAdmin/AddNamedACL`
HTTP (mf-http-grpc)	`POST /grpc/v1/add-named-acl`
Request	`AddNamedACLRequest`
Response	`AddNamedACLResponse`
Book and level	Administration API, specialized
Kind	admin
Session	Required: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotent	no
Returns metadata structure version	no
Streaming	none (unary)

Remarks

Requires the vault rights change_metadata_structure and license_allows_modifications.
The name must be unique (compared case-insensitively).
The server assigns the ID and the GUID; the values you send are ignored.

Request: AddNamedACLRequest

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page. Fields marked (recursive) refer to a type already on their path.

Field	Type	Description
`named_acladmin`	`NamedACLAdmin`	The new named ACL. See NamedACLAdmin.
`named_acladmin.named_acl`	`NamedACL`	Basic data.
`named_acladmin.named_acl.id`	`int32`	Named ACL ID.
`named_acladmin.named_acl.name`	`string`	The name of the named ACL.
`named_acladmin.named_acl.type`	`NACLType`	The type of the NACL.Values: `NACLTYPE_NONE` (0), `NACLTYPE_NORMAL` (1), `NACLTYPE_INTERNAL` (2).
`named_acladmin.named_acl.acl_for_objects`	`AccessControlList`	The predefined permissions. This defines the ACL which this named ACL encapsulates.
`named_acladmin.named_acl.guid`	`string`	GUID for the NACL.
`named_acladmin.acl`	`AccessControlList`	The permissions of this named ACL. This defines which users can see this named ACL, for example.
`named_acladmin.acl.checked_out_to_user`	`int32`	Specifies the ID of the user who has extended rights because of the checkout operation performed by her. 0 if such user does not exist.
`named_acladmin.acl.is_fully_authoritative`	`bool`	Specifies whether this access control list is set to ignore the secondary permissions that come from the latest checked in version.
`named_acladmin.acl.custom_component`	`AccessControlListComponent`	Accesses the custom component of this ACL.
`named_acladmin.acl.restrictive_components[]`	repeated `AccessControlListComponentMapEntry`	Accesses the restrictive automatic components of this ACL.
`named_acladmin.acl.secondary_access_control_list`	`AccessControlList` (recursive)	Secondary ACL used for latest version ACL. Not used for access check if null.
`named_acladmin.acl.additive_components[]`	repeated `AccessControlListComponentMapEntry`	Accesses the additive automatic components of this ACL.
`named_acladmin.aliases`	`string`	Semicolon-separated list of semantic aliases.

Response: AddNamedACLResponse

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page. Fields marked (recursive) refer to a type already on their path.

Field	Type	Description
`putf8sznamedacladmin`	`NamedACLAdmin`	The stored named ACL with its new ID and GUID.
`putf8sznamedacladmin.named_acl`	`NamedACL`	Basic data.
`putf8sznamedacladmin.named_acl.id`	`int32`	Named ACL ID.
`putf8sznamedacladmin.named_acl.name`	`string`	The name of the named ACL.
`putf8sznamedacladmin.named_acl.type`	`NACLType`	The type of the NACL.Values: `NACLTYPE_NONE` (0), `NACLTYPE_NORMAL` (1), `NACLTYPE_INTERNAL` (2).
`putf8sznamedacladmin.named_acl.acl_for_objects`	`AccessControlList`	The predefined permissions. This defines the ACL which this named ACL encapsulates.
`putf8sznamedacladmin.named_acl.guid`	`string`	GUID for the NACL.
`putf8sznamedacladmin.acl`	`AccessControlList`	The permissions of this named ACL. This defines which users can see this named ACL, for example.
`putf8sznamedacladmin.acl.checked_out_to_user`	`int32`	Specifies the ID of the user who has extended rights because of the checkout operation performed by her. 0 if such user does not exist.
`putf8sznamedacladmin.acl.is_fully_authoritative`	`bool`	Specifies whether this access control list is set to ignore the secondary permissions that come from the latest checked in version.
`putf8sznamedacladmin.acl.custom_component`	`AccessControlListComponent`	Accesses the custom component of this ACL.
`putf8sznamedacladmin.acl.restrictive_components[]`	repeated `AccessControlListComponentMapEntry`	Accesses the restrictive automatic components of this ACL.
`putf8sznamedacladmin.acl.secondary_access_control_list`	`AccessControlList` (recursive)	Secondary ACL used for latest version ACL. Not used for access check if null.
`putf8sznamedacladmin.acl.additive_components[]`	repeated `AccessControlListComponentMapEntry`	Accesses the additive automatic components of this ACL.
`putf8sznamedacladmin.aliases`	`string`	Semicolon-separated list of semantic aliases.