Class Role
-
- All Implemented Interfaces:
public final class RoleA role is a collection of permissions which can be granted as part of an ACL
Roles can consist of individual permissions, as well as a set of roles they inherit from
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classRole.BuilderA builder for Role.
public final classRole.MemberPermission
-
Method Summary
Modifier and Type Method Description final Stringid()Unique identifier for the role final Stringname()Name of the role final Optional<OffsetDateTime>created()Date of role creation final Optional<OffsetDateTime>deletedAt()Date of role deletion, or null if the role is still active final Optional<String>description()Textual description of the role final Optional<List<Role.MemberPermission>>memberPermissions()(permission, restrict_object_type) tuples which belong to this role final Optional<List<String>>memberRoles()Ids of the roles this role inherits fromAn inheriting role has all the permissions contained in its member roles, as well as all of their inherited permissions final Optional<String>orgId()Unique id for the organization that the role belongs underA null org_id indicates a system role, which may be assigned to anybody and inherited by any other role, but cannot be edited. final Optional<String>userId()Identifies the user who created the role final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<OffsetDateTime>_created()Returns the raw JSON value of created. final JsonField<OffsetDateTime>_deletedAt()Returns the raw JSON value of deletedAt. final JsonField<String>_description()Returns the raw JSON value of description. final JsonField<List<Role.MemberPermission>>_memberPermissions()Returns the raw JSON value of memberPermissions. final JsonField<List<String>>_memberRoles()Returns the raw JSON value of memberRoles. final JsonField<String>_orgId()Returns the raw JSON value of orgId. final JsonField<String>_userId()Returns the raw JSON value of userId. final Map<String, JsonValue>_additionalProperties()final Rolevalidate()final Role.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static Role.Builderbuilder()Returns a mutable builder for constructing an instance of Role. -
-
Method Detail
-
created
final Optional<OffsetDateTime> created()
Date of role creation
-
deletedAt
final Optional<OffsetDateTime> deletedAt()
Date of role deletion, or null if the role is still active
-
description
final Optional<String> description()
Textual description of the role
-
memberPermissions
final Optional<List<Role.MemberPermission>> memberPermissions()
(permission, restrict_object_type) tuples which belong to this role
-
memberRoles
final Optional<List<String>> memberRoles()
Ids of the roles this role inherits from
An inheriting role has all the permissions contained in its member roles, as well as all of their inherited permissions
-
orgId
final Optional<String> orgId()
Unique id for the organization that the role belongs under
A null org_id indicates a system role, which may be assigned to anybody and inherited by any other role, but cannot be edited.
It is forbidden to change the org after creating a role
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_created
final JsonField<OffsetDateTime> _created()
Returns the raw JSON value of created.
Unlike created, this method doesn't throw if the JSON field has an unexpected type.
-
_deletedAt
final JsonField<OffsetDateTime> _deletedAt()
Returns the raw JSON value of deletedAt.
Unlike deletedAt, this method doesn't throw if the JSON field has an unexpected type.
-
_description
final JsonField<String> _description()
Returns the raw JSON value of description.
Unlike description, this method doesn't throw if the JSON field has an unexpected type.
-
_memberPermissions
final JsonField<List<Role.MemberPermission>> _memberPermissions()
Returns the raw JSON value of memberPermissions.
Unlike memberPermissions, this method doesn't throw if the JSON field has an unexpected type.
-
_memberRoles
final JsonField<List<String>> _memberRoles()
Returns the raw JSON value of memberRoles.
Unlike memberRoles, this method doesn't throw if the JSON field has an unexpected type.
-
_orgId
final JsonField<String> _orgId()
Returns the raw JSON value of orgId.
Unlike orgId, this method doesn't throw if the JSON field has an unexpected type.
-
_userId
final JsonField<String> _userId()
Returns the raw JSON value of userId.
Unlike userId, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final Role.Builder toBuilder()
-
builder
final static Role.Builder builder()
Returns a mutable builder for constructing an instance of Role.
The following fields are required:
.id() .name()
-
-
-
-