object group extends BaseEndpoints[F, Group]
- Source
- Identity.scala
- Alphabetic
- By Inheritance
- group
- BaseEndpoints
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addMembers(name: String, members: String*): F[String]
Appends
members
to a group namedname
.Appends
members
to a group namedname
. If no group exists with that name a new group will be created.- name
name of the group.
- members
the list of entity IDs to append to the group.
- returns
the group id to which the members were appended to.
- def addPolicies(name: String, policies: String*): F[String]
Appends
policies
to a group namedname
.Appends
policies
to a group namedname
. If no group exists with that name a new group will be created.- name
name of the group.
- policies
the list of policies to append to the group.
- returns
the group id to which the policies were appended to.
- def addSubgroups(name: String, subgroupsIDs: String*): F[String]
Appends
subgroups
to a group namedname
.Appends
subgroups
to a group namedname
. If no group exists with that name a new group will be created.- name
name of the group.
- subgroupsIDs
the list of group Ids to append to the subgroups of group.
- returns
the group id to which the subgroups were appended to.
- def apply(name: String): F[Group]
Gets the group with the given
name
, assuming it exists.Gets the group with the given
name
, assuming it exists.- Definition Classes
- BaseEndpoints
- def applyById(id: String): F[Group]
Gets the group with the given
id
, assuming it exists.Gets the group with the given
id
, assuming it exists.- Definition Classes
- BaseEndpoints
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def create(name: String): F[Group]
- Attributes
- protected
- Definition Classes
- group → BaseEndpoints
- def create(name: String, policies: List[String] = List.empty, members: List[String] = List.empty, subgroups: List[String] = List.empty, type: Type = Group.Type.Internal, metadata: Map[String, String] = Map.empty): F[Group]
Creates or updates a Group.
Creates or updates a Group.
- name
name of the group.
- policies
policies to be tied to the group.
- members
entity IDs to be assigned as group members.
- subgroups
group IDs to be assigned as group members.
- metadata
metadata to be associated with the group.
- returns
the id of the created group.
- Note
This endpoint distinguishes between create and update ACL capabilities.
- def delete(name: String): F[Unit]
Deletes the group with
name
and all its associated aliases.Deletes the group with
name
and all its associated aliases.- Definition Classes
- BaseEndpoints
- def deleteById(id: String): F[Unit]
Deletes the group with
id
and all its associated aliases.Deletes the group with
id
and all its associated aliases.- Definition Classes
- BaseEndpoints
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def findOrCreate(name: String): F[Group]
Gets the group named
name
, creating one if one does not exist.Gets the group named
name
, creating one if one does not exist.- Definition Classes
- BaseEndpoints
- def get(name: String): F[Option[Group]]
Gets the group with the given
name
.Gets the group with the given
name
.- Definition Classes
- BaseEndpoints
- def getById(id: String): F[Option[Group]]
Gets the group with the given
id
.Gets the group with the given
id
.- Definition Classes
- BaseEndpoints
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val list: F[List[String]]
Lists groups by their names.
Lists groups by their names.
- Definition Classes
- BaseEndpoints
- val listById: F[List[String]]
Lists groups by their identifiers.
Lists groups by their identifiers.
- Definition Classes
- BaseEndpoints
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val path: String
- Definition Classes
- BaseEndpoints
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def update(group: Group): F[Unit]
Updates
group
.Updates
group
.- group
the group to update.
- def update(id: String, name: String, policies: List[String] = List.empty, members: List[String] = List.empty, subgroups: List[String] = List.empty, type: Type = Group.Type.Internal, metadata: Map[String, String] = Map.empty): F[Unit]
Updates an existing group.
Updates an existing group.
- id
identifier of the group.
- name
name of the group.
- policies
policies to be tied to the group.
- members
entity IDs to be assigned as group members.
- subgroups
group IDs to be assigned as group members.
- metadata
metadata to be associated with the group.
- val uri: Uri
- Definition Classes
- BaseEndpoints
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()