localuser:authservice : Local user authentication service object.

The object represents a local authentication service for authenticating users against the local database.

Note that read by reference is not supported.

Object Reference

References to localuser:authservice are object references.

The name part of a local user authentication service reference has the following components:

  • The local user authentication service name.

Example: localuser:authservice/ZG5zLm5ldHdvcmtfdmlldyQxMTk:local1

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • Modify (update)
  • Permissions
  • Read by object reference
  • Global search (searches via the search object)
  • Scheduling
  • CSV export

The object cannot be managed on Cloud Platform members.

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): comment, disabled, name.

comment

comment

The local user authentication service comment.

Type

String.

Search

The field is not available for search.

Notes

The comment is part of the base object.

The comment cannot be updated.

comment cannot be written.

disabled

disabled

Flag that indicates whether the local user authentication service is enabled or not.

Type

Bool.

Search

The field is not available for search.

Notes

The disabled is part of the base object.

The disabled cannot be updated.

disabled cannot be written.

name

name

The name of the local user authentication service.

Type

String.

Search

The field is not available for search.

Notes

The name is part of the base object.

The name cannot be updated.

name cannot be written.

Fields List

Field Type Req R/O Base Search
comment String N Y Y N/A
disabled Bool N Y Y N/A
name String N Y Y N/A