Packages

object entity extends BaseEndpoints[F, Entity]

Source
Identity.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. entity
  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 addPolicies(name: String, policies: String*): F[String]

    Appends policies to an entity named name.

    Appends policies to an entity named name. If no entity exists with that name a new entity will be created.

    name

    name of the entity.

    policies

    the list of policies to append to the entity.

    returns

    the entity id to which the policies were appended to.

  5. def apply(name: String): F[Entity]

    Gets the entity with the given name, assuming it exists.

    Gets the entity with the given name, assuming it exists.

    Definition Classes
    BaseEndpoints
  6. def applyById(id: String): F[Entity]

    Gets the entity with the given id, assuming it exists.

    Gets the entity with the given id, assuming it exists.

    Definition Classes
    BaseEndpoints
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def batchDelete(ids: List[String]): F[Unit]

    Deletes all entities provided.

    Deletes all entities provided.

    ids

    list of entity identifiers to delete.

  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def create(name: String): F[Entity]
    Attributes
    protected
    Definition Classes
    entityBaseEndpoints
  11. def create(name: String, policies: List[String] = List.empty, disabled: Boolean = false, metadata: Map[String, String] = Map.empty): F[Entity]

    Create or update an entity by a given name.

    Create or update an entity by a given name.

    name

    name of the entity.

    policies

    policies to be tied to the entity.

    disabled

    whether the entity is disabled. Disabled entities' associated tokens cannot be used, but are not revoked.

    metadata

    metadata to be associated with the entity.

    returns

    the entity id.

  12. def delete(name: String): F[Unit]

    Deletes the entity with name and all its associated aliases.

    Deletes the entity with name and all its associated aliases.

    Definition Classes
    BaseEndpoints
  13. def deleteById(id: String): F[Unit]

    Deletes the entity with id and all its associated aliases.

    Deletes the entity with id and all its associated aliases.

    Definition Classes
    BaseEndpoints
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. def findOrCreate(name: String): F[Entity]

    Gets the entity named name, creating one if one does not exist.

    Gets the entity named name, creating one if one does not exist.

    Definition Classes
    BaseEndpoints
  18. def get(name: String): F[Option[Entity]]

    Gets the entity with the given name.

    Gets the entity with the given name.

    Definition Classes
    BaseEndpoints
  19. def getById(id: String): F[Option[Entity]]

    Gets the entity with the given id.

    Gets the entity with the given id.

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

    Lists entities by their names.

    Lists entities by their names.

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

    Lists entities by their identifiers.

    Lists entities by their identifiers.

    Definition Classes
    BaseEndpoints
  25. def merge(from: List[String], to: String, force: Boolean = false): F[Unit]

    Merges many entities into one entity.

    Merges many entities into one entity.

    from

    Entity IDs which needs to get merged.

    to

    Entity ID into which all the other entities need to get merged.

    force

    Setting this will follow the 'mine' strategy for merging MFA secrets. If there are secrets of the same type both in entities that are merged from and in entity into which all others are getting merged, secrets in the destination will be unaltered. If not set, this API will throw an error containing all the conflicts.

  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(entity: Entity): F[Unit]

    Updates an entity using entity to fetch the values for id, name, policies, disabled, and metadata.

    Updates an entity using entity to fetch the values for id, name, policies, disabled, and metadata. Any other field will not be used.

    entity

    the entity from which to fetch the values.

  33. def update(id: String, name: String, policies: List[String] = List.empty, disabled: Boolean = false, metadata: Map[String, String] = Map.empty): F[Unit]

    Updates an existing entity.

    Updates an existing entity.

    id

    identifier of the entity.

    name

    name of the entity.

    policies

    policies to be tied to the entity.

    disabled

    whether the entity is disabled. Disabled entities' associated tokens cannot be used, but are not revoked.

    metadata

    metadata to be associated with the entity.

    returns

    the entity id.

  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, Entity]

Inherited from AnyRef

Inherited from Any

Ungrouped