Skip to main content
Sign Out

Welcome to Dell

My Account
  • Place orders quickly and easily
  • View orders and track your shipping status
  • Enjoy members-only rewards and discounts
  • Create and access a list of your products
  • Manage your Dell EMC sites, products, and product-level contacts using Company Administration.
Sign In Create an Account Dell Financial Services Premier Sign In Partner Program Sign In
Contact Us

Your Dell.com Carts

PowerScale OneFS API Reference

PDF

Authentication classes

Authentication classes define values for the object properties in authentication resources.

<persona-id>

The <persona-id> class must be set in the following format: user:<string>, group:<string>, SID:<string>, UID:<string>, GID:<string>, such as: GID:2003 or user:johndoe.

<persona>

The <persona> class must be set with either the persona-id or the type and name parameters, as follows:

Property Type Description
id <persona-id> Specifies the serialized form of the persona
type String Specifies the type of persona which is combined with a name. The type of the persona can be set to user, group, or wellknown.
name String Specifies the persona name, which is combined with a type

<user-id>

The <user-id> class must be set in the following format: user:<string>, SID:<string>, UID:<string>, such as: UID:2283 or user:johndoe.

<user>

The <user> class contains the following properties:

Property Type Description
dn String Specifies the distinguished name for the user
dns_domain String Specifies the DNS domain
domain String Specifies the domain that the object is part of
email String Specifies an email address
enabled Boolean True if the user is enabled.
expired Boolean True if the password for the user has expired.
expiry Integer Specifies the UNIX Epoch time at which the user account expires.
gecos String Specifies the GECOS value, which is usually the full name
generated_gid Boolean Indicates if the GID was generated.
generated_uid Boolean Indicates if the UID was generated.
gid <persona> Specifies the group ID
home_directory String Specifies the home directory for the user
id String Specifies the system ID given to the user or group. In a POST request, this value is the ID that indicates the item in the collection item resource path.
locked Boolean Specifies if the account is locked.
max_password_age Integer Specifies the maximum age in seconds allowed for the password before the password expires.
member_of Array of [<persona>] Specifies groups that this user or group is members of
name String Specifies a user or group name
password_expired Boolean Specifies whether the password has expired.
password_expires Boolean Specifies whether the password is allowed to expire.
password_last_set Integer Specifies the last time that the password was set
primary_group_sid <persona> Specifies the security ID of the primary group for the user
prompt_password_change Boolean Prompts a password change for the user at the next login
provider String Specifies the authentication provider the object belongs to.
sam_account_name String Specifies a user or group name
shell String Specifies the path to the shell for the user
sid <persona> Specifies the security identifier
type String Indicates the object type
uid <persona> Specifies the user ID
upn String Specifies the principal name for the user
user_can_change_password Boolean Specifies whether the user can change their own password.

<group-id>

The <group-id> class must be set in the following format: group:<string>, SID:<string>, GID:<string>, such as: GID:2003 or group:admins.

<group>

The <group> class contains the following properties:

Property Type Type Property of
dn String Specifies the distinguished name for the group or object. groups
dns_domain String Specifies the DNS domain for the object. groups
domain String Specifies the domain of the group. groups
generated_gid Boolean Indicates if the GID was generated. groups
gid <persona> Specifies properties for the persona. groups
id String Specifies the system ID given to the user or group. In a POST request, this value indicates the item in the collection item resource path. groups
member_of Array of [<persona>] Specifies properties for groups that this user or group is member of groups
name String Specifies a user or group name groups
provider String Specifies an authentication provider groups
sam_account_name String Specifies a user or group name groups
sid <persona> Specifies properties for the security identifier groups
type String Indicates the object type groups

<privilege>

The <privilege> class must be set as follows:

Property Type Description
id String Specifies the formal name of the privilege
name String Specifies the name of the privilege
permission String Determines if the privilege is specified as no-permission, read, execute, or write.

Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please select whether the article was helpful or not.
  Comments cannot contain these special characters: <>()\