object entity extends BaseEndpoints[F, Entity]
- Source
- Identity.scala
- Alphabetic
- By Inheritance
- entity
- 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 addPolicies(name: String, policies: String*): F[String]
Appends
policies
to an entity namedname
.Appends
policies
to an entity namedname
. 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.
- 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
- 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def batchDelete(ids: List[String]): F[Unit]
Deletes all entities provided.
Deletes all entities provided.
- ids
list of entity identifiers to delete.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def create(name: String): F[Entity]
- Attributes
- protected
- Definition Classes
- entity → BaseEndpoints
- 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.
- 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
- 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
- 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[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
- def get(name: String): F[Option[Entity]]
Gets the entity with the given
name
.Gets the entity with the given
name
.- Definition Classes
- BaseEndpoints
- def getById(id: String): F[Option[Entity]]
Gets the entity with the given
id
.Gets the entity 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 entities by their names.
Lists entities by their names.
- Definition Classes
- BaseEndpoints
- val listById: F[List[String]]
Lists entities by their identifiers.
Lists entities by their identifiers.
- Definition Classes
- BaseEndpoints
- 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.
- 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(entity: Entity): F[Unit]
Updates an entity using
entity
to fetch the values forid
,name
,policies
,disabled
, andmetadata
.Updates an entity using
entity
to fetch the values forid
,name
,policies
,disabled
, andmetadata
. Any other field will not be used.- entity
the entity from which to fetch the values.
- 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.
- 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()