Packages

object group extends BaseEndpoints[F, Group]

Source
Identity.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. group
  2. BaseEndpoints
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addMembers(name: String, members: String*): F[String]

    Appends members to a group named name.

    Appends members to a group named name. 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.

  5. def addPolicies(name: String, policies: String*): F[String]

    Appends policies to a group named name.

    Appends policies to a group named name. 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.

  6. def addSubgroups(name: String, subgroupsIDs: String*): F[String]

    Appends subgroups to a group named name.

    Appends subgroups to a group named name. 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.

  7. 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
  8. 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
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. def create(name: String): F[Group]
    Attributes
    protected
    Definition Classes
    groupBaseEndpoints
  12. 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.

  13. 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
  14. 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
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  18. 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
  19. def get(name: String): F[Option[Group]]

    Gets the group with the given name.

    Gets the group with the given name.

    Definition Classes
    BaseEndpoints
  20. def getById(id: String): F[Option[Group]]

    Gets the group with the given id.

    Gets the group with the given id.

    Definition Classes
    BaseEndpoints
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. val list: F[List[String]]

    Lists groups by their names.

    Lists groups by their names.

    Definition Classes
    BaseEndpoints
  25. val listById: F[List[String]]

    Lists groups by their identifiers.

    Lists groups by their identifiers.

    Definition Classes
    BaseEndpoints
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. val path: String
    Definition Classes
    BaseEndpoints
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. def update(group: Group): F[Unit]

    Updates group.

    Updates group.

    group

    the group to update.

  33. 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.

  34. val uri: Uri
    Definition Classes
    BaseEndpoints
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from BaseEndpoints[F, Group]

Inherited from AnyRef

Inherited from Any

Ungrouped