LettaAPI.Api.Identities (letta_api v1.0.0)
API calls for all endpoints tagged Identities
.
Summary
Functions
Count Identities Get count of all identities for a user
Count Identities Get count of all identities for a user
Create Identity
Create Identity
Delete Identity Delete an identity by its identifier key
Delete Identity Delete an identity by its identifier key
List Identities Get a list of all identities in the database
List Identities Get a list of all identities in the database
Retrieve Identity
Retrieve Identity
Upsert Identity
Upsert Identity
Upsert Identity Properties
Upsert Identity Properties
Functions
@spec count_identities( Tesla.Env.client(), keyword() ) :: {:ok, integer()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Count Identities Get count of all identities for a user
Parameters
connection
(LettaAPI.Connection): Connection to serveropts
(keyword): Optional parameters:user_id
(String.t):
Returns
{:ok, integer()}
on success{:error, Tesla.Env.t}
on failure
@spec count_identities_0( Tesla.Env.client(), keyword() ) :: {:ok, integer()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Count Identities Get count of all identities for a user
Parameters
connection
(LettaAPI.Connection): Connection to serveropts
(keyword): Optional parameters:user_id
(String.t):
Returns
{:ok, integer()}
on success{:error, Tesla.Env.t}
on failure
@spec create_identity( Tesla.Env.client(), LettaAPI.Model.IdentityCreate.t(), keyword() ) :: {:ok, LettaAPI.Model.Identity.t()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Create Identity
Parameters
connection
(LettaAPI.Connection): Connection to serveridentity_create
(IdentityCreate):opts
(keyword): Optional parameters:user_id
(String.t)::"X-Project"
(String.t):
Returns
{:ok, LettaAPI.Model.Identity.t}
on success{:error, Tesla.Env.t}
on failure
@spec create_identity_0( Tesla.Env.client(), LettaAPI.Model.IdentityCreate.t(), keyword() ) :: {:ok, LettaAPI.Model.Identity.t()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Create Identity
Parameters
connection
(LettaAPI.Connection): Connection to serveridentity_create
(IdentityCreate):opts
(keyword): Optional parameters:user_id
(String.t)::"X-Project"
(String.t):
Returns
{:ok, LettaAPI.Model.Identity.t}
on success{:error, Tesla.Env.t}
on failure
@spec delete_identity(Tesla.Env.client(), String.t(), keyword()) :: {:ok, any()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Delete Identity Delete an identity by its identifier key
Parameters
connection
(LettaAPI.Connection): Connection to serveridentity_id
(String.t):opts
(keyword): Optional parameters:user_id
(String.t):
Returns
{:ok, any()}
on success{:error, Tesla.Env.t}
on failure
@spec delete_identity_0(Tesla.Env.client(), String.t(), keyword()) :: {:ok, any()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Delete Identity Delete an identity by its identifier key
Parameters
connection
(LettaAPI.Connection): Connection to serveridentity_id
(String.t):opts
(keyword): Optional parameters:user_id
(String.t):
Returns
{:ok, any()}
on success{:error, Tesla.Env.t}
on failure
@spec list_identities( Tesla.Env.client(), keyword() ) :: {:ok, [LettaAPI.Model.Identity.t()]} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
List Identities Get a list of all identities in the database
Parameters
connection
(LettaAPI.Connection): Connection to serveropts
(keyword): Optional parameters:name
(String.t)::project_id
(String.t)::identifier_key
(String.t)::identity_type
(IdentityType)::before
(String.t)::after
(String.t)::limit
(integer())::user_id
(String.t):
Returns
{:ok, [%Identity{}, ...]}
on success{:error, Tesla.Env.t}
on failure
@spec list_identities_0( Tesla.Env.client(), keyword() ) :: {:ok, [LettaAPI.Model.Identity.t()]} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
List Identities Get a list of all identities in the database
Parameters
connection
(LettaAPI.Connection): Connection to serveropts
(keyword): Optional parameters:name
(String.t)::project_id
(String.t)::identifier_key
(String.t)::identity_type
(IdentityType)::before
(String.t)::after
(String.t)::limit
(integer())::user_id
(String.t):
Returns
{:ok, [%Identity{}, ...]}
on success{:error, Tesla.Env.t}
on failure
@spec retrieve_identity(Tesla.Env.client(), String.t(), keyword()) :: {:ok, LettaAPI.Model.Identity.t()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Retrieve Identity
Parameters
connection
(LettaAPI.Connection): Connection to serveridentity_id
(String.t):opts
(keyword): Optional parameters:user_id
(String.t):
Returns
{:ok, LettaAPI.Model.Identity.t}
on success{:error, Tesla.Env.t}
on failure
@spec retrieve_identity_0(Tesla.Env.client(), String.t(), keyword()) :: {:ok, LettaAPI.Model.Identity.t()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Retrieve Identity
Parameters
connection
(LettaAPI.Connection): Connection to serveridentity_id
(String.t):opts
(keyword): Optional parameters:user_id
(String.t):
Returns
{:ok, LettaAPI.Model.Identity.t}
on success{:error, Tesla.Env.t}
on failure
@spec update_identity( Tesla.Env.client(), String.t(), LettaAPI.Model.IdentityUpdate.t(), keyword() ) :: {:ok, LettaAPI.Model.Identity.t()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Modify Identity
Parameters
connection
(LettaAPI.Connection): Connection to serveridentity_id
(String.t):identity_update
(IdentityUpdate):opts
(keyword): Optional parameters:user_id
(String.t):
Returns
{:ok, LettaAPI.Model.Identity.t}
on success{:error, Tesla.Env.t}
on failure
@spec update_identity_0( Tesla.Env.client(), String.t(), LettaAPI.Model.IdentityUpdate.t(), keyword() ) :: {:ok, LettaAPI.Model.Identity.t()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Modify Identity
Parameters
connection
(LettaAPI.Connection): Connection to serveridentity_id
(String.t):identity_update
(IdentityUpdate):opts
(keyword): Optional parameters:user_id
(String.t):
Returns
{:ok, LettaAPI.Model.Identity.t}
on success{:error, Tesla.Env.t}
on failure
@spec upsert_identity( Tesla.Env.client(), LettaAPI.Model.IdentityUpsert.t(), keyword() ) :: {:ok, LettaAPI.Model.Identity.t()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Upsert Identity
Parameters
connection
(LettaAPI.Connection): Connection to serveridentity_upsert
(IdentityUpsert):opts
(keyword): Optional parameters:user_id
(String.t)::"X-Project"
(String.t):
Returns
{:ok, LettaAPI.Model.Identity.t}
on success{:error, Tesla.Env.t}
on failure
@spec upsert_identity_0( Tesla.Env.client(), LettaAPI.Model.IdentityUpsert.t(), keyword() ) :: {:ok, LettaAPI.Model.Identity.t()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Upsert Identity
Parameters
connection
(LettaAPI.Connection): Connection to serveridentity_upsert
(IdentityUpsert):opts
(keyword): Optional parameters:user_id
(String.t)::"X-Project"
(String.t):
Returns
{:ok, LettaAPI.Model.Identity.t}
on success{:error, Tesla.Env.t}
on failure
@spec upsert_identity_properties( Tesla.Env.client(), String.t(), [LettaAPI.Model.IdentityProperty.t()], keyword() ) :: {:ok, any()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Upsert Identity Properties
Parameters
connection
(LettaAPI.Connection): Connection to serveridentity_id
(String.t):identity_property
([LettaAPI.Model.IdentityProperty.t]):opts
(keyword): Optional parameters:user_id
(String.t):
Returns
{:ok, any()}
on success{:error, Tesla.Env.t}
on failure
@spec upsert_identity_properties_0( Tesla.Env.client(), String.t(), [LettaAPI.Model.IdentityProperty.t()], keyword() ) :: {:ok, any()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Upsert Identity Properties
Parameters
connection
(LettaAPI.Connection): Connection to serveridentity_id
(String.t):identity_property
([LettaAPI.Model.IdentityProperty.t]):opts
(keyword): Optional parameters:user_id
(String.t):
Returns
{:ok, any()}
on success{:error, Tesla.Env.t}
on failure