Package ai.vectros.resources.identity

Class IdentityClient

java.lang.Object
ai.vectros.resources.identity.IdentityClient
public class IdentityClient extends Object

  • Field Details

  • Constructor Details

    • IdentityClient

      public IdentityClient(ClientOptions clientOptions)

  • Method Details

    • withRawResponse

      public RawIdentityClient withRawResponse()
      Get responses with HTTP metadata like headers

    • listClients

      public ClientPage listClients()
      Returns a paginated list of clients in your account. Narrow the results with orgId or userId, or use externalId for an exact lookup by your own identifier. For schema-bound clients, you can also query by a schema-declared lookup field using type, field, and one lookup mode (value for equality, from/to for a range, or prefix). The response is a {data, nextCursor} envelope; pass nextCursor back as startFrom to fetch the next page. Requires the clients:r scope.

    • listClients

      public ClientPage listClients(RequestOptions requestOptions)
      Returns a paginated list of clients in your account. Narrow the results with orgId or userId, or use externalId for an exact lookup by your own identifier. For schema-bound clients, you can also query by a schema-declared lookup field using type, field, and one lookup mode (value for equality, from/to for a range, or prefix). The response is a {data, nextCursor} envelope; pass nextCursor back as startFrom to fetch the next page. Requires the clients:r scope.

    • listClients

      public ClientPage listClients(ListClientsRequest request)
      Returns a paginated list of clients in your account. Narrow the results with orgId or userId, or use externalId for an exact lookup by your own identifier. For schema-bound clients, you can also query by a schema-declared lookup field using type, field, and one lookup mode (value for equality, from/to for a range, or prefix). The response is a {data, nextCursor} envelope; pass nextCursor back as startFrom to fetch the next page. Requires the clients:r scope.

    • listClients

      public ClientPage listClients(ListClientsRequest request, RequestOptions requestOptions)
      Returns a paginated list of clients in your account. Narrow the results with orgId or userId, or use externalId for an exact lookup by your own identifier. For schema-bound clients, you can also query by a schema-declared lookup field using type, field, and one lookup mode (value for equality, from/to for a range, or prefix). The response is a {data, nextCursor} envelope; pass nextCursor back as startFrom to fetch the next page. Requires the clients:r scope.

    • createClient

      public ClientResponse createClient(ClientRequest request)
      Creates a new client identity in your account. This call is idempotent on externalId: if a client with the same externalId already exists, the existing record is returned instead of creating a duplicate. Requires the clients:c scope.

    • createClient

      public ClientResponse createClient(ClientRequest request, RequestOptions requestOptions)
      Creates a new client identity in your account. This call is idempotent on externalId: if a client with the same externalId already exists, the existing record is returned instead of creating a duplicate. Requires the clients:c scope.

    • getClient

      public ClientResponse getClient(String id)
      Returns a single client by its Vectros-assigned UUID. Requires the clients:r scope.

    • getClient

      public ClientResponse getClient(String id, RequestOptions requestOptions)
      Returns a single client by its Vectros-assigned UUID. Requires the clients:r scope.

    • getClient

      public ClientResponse getClient(String id, GetClientRequest request)
      Returns a single client by its Vectros-assigned UUID. Requires the clients:r scope.

    • getClient

      public ClientResponse getClient(String id, GetClientRequest request, RequestOptions requestOptions)
      Returns a single client by its Vectros-assigned UUID. Requires the clients:r scope.

    • updateClient

      public ClientResponse updateClient(String id, UpdateClientRequest request)
      Updates mutable fields on an existing client. Omitted fields are preserved (a null does not clear a field); when payload is supplied it replaces the stored payload in full rather than being deep-merged. Requires the clients:u scope.

    • updateClient

      public ClientResponse updateClient(String id, UpdateClientRequest request, RequestOptions requestOptions)
      Updates mutable fields on an existing client. Omitted fields are preserved (a null does not clear a field); when payload is supplied it replaces the stored payload in full rather than being deep-merged. Requires the clients:u scope.

    • deleteClient

      public void deleteClient(String id)
      Permanently deletes the client. This action cannot be undone. Requires the clients:d scope.

    • deleteClient

      public void deleteClient(String id, RequestOptions requestOptions)
      Permanently deletes the client. This action cannot be undone. Requires the clients:d scope.

    • deleteClient

      public void deleteClient(String id, DeleteClientRequest request)
      Permanently deletes the client. This action cannot be undone. Requires the clients:d scope.

    • deleteClient

      public void deleteClient(String id, DeleteClientRequest request, RequestOptions requestOptions)
      Permanently deletes the client. This action cannot be undone. Requires the clients:d scope.

    • lookupClients

      public ClientPage lookupClients(IdentityLookupRequest request)
      Body-based equivalent of the type/field/value lookup on GET /v1/clients. Use this when looking up by a sensitive (blind-indexed) field: the value travels in the request body rather than the URL. The GET list rejects a sensitive field's value and directs you here. The response is a {data, nextCursor} envelope. Requires the clients:r scope.

    • lookupClients

      public ClientPage lookupClients(IdentityLookupRequest request, RequestOptions requestOptions)
      Body-based equivalent of the type/field/value lookup on GET /v1/clients. Use this when looking up by a sensitive (blind-indexed) field: the value travels in the request body rather than the URL. The GET list rejects a sensitive field's value and directs you here. The response is a {data, nextCursor} envelope. Requires the clients:r scope.

    • getClientVersions

      public ModelDataVersionPage getClientVersions(String id)
      Returns the audit trail of changes to a client, newest first. Identity auditing is always on, so this history is always available; sensitive field values are redacted in each version. The response is a {data, nextCursor} envelope. Requires the clients:r scope.

    • getClientVersions

      public ModelDataVersionPage getClientVersions(String id, RequestOptions requestOptions)
      Returns the audit trail of changes to a client, newest first. Identity auditing is always on, so this history is always available; sensitive field values are redacted in each version. The response is a {data, nextCursor} envelope. Requires the clients:r scope.

    • getClientVersions

      public ModelDataVersionPage getClientVersions(String id, GetClientVersionsRequest request)
      Returns the audit trail of changes to a client, newest first. Identity auditing is always on, so this history is always available; sensitive field values are redacted in each version. The response is a {data, nextCursor} envelope. Requires the clients:r scope.

    • getClientVersions

      public ModelDataVersionPage getClientVersions(String id, GetClientVersionsRequest request, RequestOptions requestOptions)
      Returns the audit trail of changes to a client, newest first. Identity auditing is always on, so this history is always available; sensitive field values are redacted in each version. The response is a {data, nextCursor} envelope. Requires the clients:r scope.

    • listOrgs

      public OrgPage listOrgs()
      Returns a paginated list of organizations in your account. Filter by userId to return only the organizations owned by a specific user, or by externalId for an exact lookup using your own identifier. You can also query schema-declared lookup fields by supplying type and field together with one lookup mode (value for equality, from/to for a range, or prefix). Requires the orgs:r scope.

    • listOrgs

      public OrgPage listOrgs(RequestOptions requestOptions)
      Returns a paginated list of organizations in your account. Filter by userId to return only the organizations owned by a specific user, or by externalId for an exact lookup using your own identifier. You can also query schema-declared lookup fields by supplying type and field together with one lookup mode (value for equality, from/to for a range, or prefix). Requires the orgs:r scope.

    • listOrgs

      public OrgPage listOrgs(ListOrgsRequest request)
      Returns a paginated list of organizations in your account. Filter by userId to return only the organizations owned by a specific user, or by externalId for an exact lookup using your own identifier. You can also query schema-declared lookup fields by supplying type and field together with one lookup mode (value for equality, from/to for a range, or prefix). Requires the orgs:r scope.

    • listOrgs

      public OrgPage listOrgs(ListOrgsRequest request, RequestOptions requestOptions)
      Returns a paginated list of organizations in your account. Filter by userId to return only the organizations owned by a specific user, or by externalId for an exact lookup using your own identifier. You can also query schema-declared lookup fields by supplying type and field together with one lookup mode (value for equality, from/to for a range, or prefix). Requires the orgs:r scope.

    • createOrg

      public OrgResponse createOrg(OrgRequest request)
      Creates a new organization in your account. This call is idempotent on externalId: if an organization with the same externalId already exists, the existing record is returned instead of creating a duplicate. Requires the orgs:c scope.

    • createOrg

      public OrgResponse createOrg(OrgRequest request, RequestOptions requestOptions)
      Creates a new organization in your account. This call is idempotent on externalId: if an organization with the same externalId already exists, the existing record is returned instead of creating a duplicate. Requires the orgs:c scope.

    • getOrg

      public OrgResponse getOrg(String id)
      Retrieves a single organization by its Vectros-assigned ID, returning its current name, status, payload, and schema binding. Requires the orgs:r scope.

    • getOrg

      public OrgResponse getOrg(String id, RequestOptions requestOptions)
      Retrieves a single organization by its Vectros-assigned ID, returning its current name, status, payload, and schema binding. Requires the orgs:r scope.

    • getOrg

      public OrgResponse getOrg(String id, GetOrgRequest request)
      Retrieves a single organization by its Vectros-assigned ID, returning its current name, status, payload, and schema binding. Requires the orgs:r scope.

    • getOrg

      public OrgResponse getOrg(String id, GetOrgRequest request, RequestOptions requestOptions)
      Retrieves a single organization by its Vectros-assigned ID, returning its current name, status, payload, and schema binding. Requires the orgs:r scope.

    • updateOrg

      public OrgResponse updateOrg(String id, UpdateOrgRequest request)
      Updates the mutable fields of an organization. Omitted fields are preserved (a null value does not clear a field), and the payload object is replaced in full when supplied rather than deep-merged. Requires the orgs:u scope.

    • updateOrg

      public OrgResponse updateOrg(String id, UpdateOrgRequest request, RequestOptions requestOptions)
      Updates the mutable fields of an organization. Omitted fields are preserved (a null value does not clear a field), and the payload object is replaced in full when supplied rather than deep-merged. Requires the orgs:u scope.

    • deleteOrg

      public void deleteOrg(String id)
      Permanently deletes an organization. This action cannot be undone. Requires the orgs:d scope.

    • deleteOrg

      public void deleteOrg(String id, RequestOptions requestOptions)
      Permanently deletes an organization. This action cannot be undone. Requires the orgs:d scope.

    • deleteOrg

      public void deleteOrg(String id, DeleteOrgRequest request)
      Permanently deletes an organization. This action cannot be undone. Requires the orgs:d scope.

    • deleteOrg

      public void deleteOrg(String id, DeleteOrgRequest request, RequestOptions requestOptions)
      Permanently deletes an organization. This action cannot be undone. Requires the orgs:d scope.

    • lookupOrgs

      public OrgPage lookupOrgs(IdentityLookupRequest request)
      Looks up organizations by a schema-declared field value, with the search criteria sent in the request body instead of the URL. Use this when looking up by a sensitive field: the value travels in the body and is never exposed in the URL. This is the body-based equivalent of the type/field/value lookup on GET /v1/orgs, which rejects sensitive-field values and directs you here. Returns a {data, nextCursor} envelope. Requires the orgs:r scope.

    • lookupOrgs

      public OrgPage lookupOrgs(IdentityLookupRequest request, RequestOptions requestOptions)
      Looks up organizations by a schema-declared field value, with the search criteria sent in the request body instead of the URL. Use this when looking up by a sensitive field: the value travels in the body and is never exposed in the URL. This is the body-based equivalent of the type/field/value lookup on GET /v1/orgs, which rejects sensitive-field values and directs you here. Returns a {data, nextCursor} envelope. Requires the orgs:r scope.

    • getOrgVersions

      public ModelDataVersionPage getOrgVersions(String id)
      Returns the audit trail of changes made to an organization, newest first. Version history is always recorded for identity entities, and sensitive field values are redacted in the history. Requires the orgs:r scope.

    • getOrgVersions

      public ModelDataVersionPage getOrgVersions(String id, RequestOptions requestOptions)
      Returns the audit trail of changes made to an organization, newest first. Version history is always recorded for identity entities, and sensitive field values are redacted in the history. Requires the orgs:r scope.

    • getOrgVersions

      public ModelDataVersionPage getOrgVersions(String id, GetOrgVersionsRequest request)
      Returns the audit trail of changes made to an organization, newest first. Version history is always recorded for identity entities, and sensitive field values are redacted in the history. Requires the orgs:r scope.

    • getOrgVersions

      public ModelDataVersionPage getOrgVersions(String id, GetOrgVersionsRequest request, RequestOptions requestOptions)
      Returns the audit trail of changes made to an organization, newest first. Version history is always recorded for identity entities, and sensitive field values are redacted in the history. Requires the orgs:r scope.

    • listUsers

      public UserPage listUsers()
      Returns a paginated list of the users in your account. Pass externalId to look up a single user by your own identifier. To filter on schema-declared lookup fields, supply type and field together with one lookup mode: value (exact match), from+to (range), or prefix. Requires the users:r scope.

    • listUsers

      public UserPage listUsers(RequestOptions requestOptions)
      Returns a paginated list of the users in your account. Pass externalId to look up a single user by your own identifier. To filter on schema-declared lookup fields, supply type and field together with one lookup mode: value (exact match), from+to (range), or prefix. Requires the users:r scope.

    • listUsers

      public UserPage listUsers(ListUsersRequest request)
      Returns a paginated list of the users in your account. Pass externalId to look up a single user by your own identifier. To filter on schema-declared lookup fields, supply type and field together with one lookup mode: value (exact match), from+to (range), or prefix. Requires the users:r scope.

    • listUsers

      public UserPage listUsers(ListUsersRequest request, RequestOptions requestOptions)
      Returns a paginated list of the users in your account. Pass externalId to look up a single user by your own identifier. To filter on schema-declared lookup fields, supply type and field together with one lookup mode: value (exact match), from+to (range), or prefix. Requires the users:r scope.

    • createUser

      public UserResponse createUser(UserRequest request)
      Creates a user identity in your account. The operation is idempotent on externalId: if a user with the same externalId already exists, the existing record is returned instead of creating a duplicate. Requires the users:c scope.

    • createUser

      public UserResponse createUser(UserRequest request, RequestOptions requestOptions)
      Creates a user identity in your account. The operation is idempotent on externalId: if a user with the same externalId already exists, the existing record is returned instead of creating a duplicate. Requires the users:c scope.

    • getUser

      public UserResponse getUser(String id)
      Retrieves a single user by its Vectros-assigned ID. Requires the users:r scope.

    • getUser

      public UserResponse getUser(String id, RequestOptions requestOptions)
      Retrieves a single user by its Vectros-assigned ID. Requires the users:r scope.

    • getUser

      public UserResponse getUser(String id, GetUserRequest request)
      Retrieves a single user by its Vectros-assigned ID. Requires the users:r scope.

    • getUser

      public UserResponse getUser(String id, GetUserRequest request, RequestOptions requestOptions)
      Retrieves a single user by its Vectros-assigned ID. Requires the users:r scope.

    • updateUser

      public UserResponse updateUser(String id, UpdateUserRequest request)
      Updates mutable fields on an existing user (such as email, status, payload, or schema binding). The type field is immutable after creation. This endpoint also activates an invited user: a PUT that moves a PENDING user to ACTIVE and carries inviteToken, externalSubject, and emailVerifiedAttestation=true completes the invitation. Requires the users:u scope.

    • updateUser

      public UserResponse updateUser(String id, UpdateUserRequest request, RequestOptions requestOptions)
      Updates mutable fields on an existing user (such as email, status, payload, or schema binding). The type field is immutable after creation. This endpoint also activates an invited user: a PUT that moves a PENDING user to ACTIVE and carries inviteToken, externalSubject, and emailVerifiedAttestation=true completes the invitation. Requires the users:u scope.

    • deleteUser

      public void deleteUser(String id)
      Permanently deletes a user identity. This cannot be undone. If the user is a pending invitation, the associated access profile created for that invitation is also removed. Requires the users:d scope.

    • deleteUser

      public void deleteUser(String id, RequestOptions requestOptions)
      Permanently deletes a user identity. This cannot be undone. If the user is a pending invitation, the associated access profile created for that invitation is also removed. Requires the users:d scope.

    • deleteUser

      public void deleteUser(String id, DeleteUserRequest request)
      Permanently deletes a user identity. This cannot be undone. If the user is a pending invitation, the associated access profile created for that invitation is also removed. Requires the users:d scope.

    • deleteUser

      public void deleteUser(String id, DeleteUserRequest request, RequestOptions requestOptions)
      Permanently deletes a user identity. This cannot be undone. If the user is a pending invitation, the associated access profile created for that invitation is also removed. Requires the users:d scope.

    • lookupUsers

      public UserPage lookupUsers(IdentityLookupRequest request)
      Looks up users by a schema lookup field, with the query criteria carried in the request body rather than the URL. Use this when looking up by a sensitive (blind-indexed) field: the value is blind-indexed server-side and never appears in the URL, request logs, or proxies. The query semantics are identical to the GET /v1/users lookup, which rejects sensitive-field values and directs you here. Returns a page in the {data, nextCursor} envelope. Requires the users:r scope.

    • lookupUsers

      public UserPage lookupUsers(IdentityLookupRequest request, RequestOptions requestOptions)
      Looks up users by a schema lookup field, with the query criteria carried in the request body rather than the URL. Use this when looking up by a sensitive (blind-indexed) field: the value is blind-indexed server-side and never appears in the URL, request logs, or proxies. The query semantics are identical to the GET /v1/users lookup, which rejects sensitive-field values and directs you here. Returns a page in the {data, nextCursor} envelope. Requires the users:r scope.

    • getUserVersions

      public ModelDataVersionPage getUserVersions(String id)
      Returns the audit trail of changes to a user, most recent first. Identity history is always recorded and always available. Sensitive field values are redacted in every historical version. Returns a page in the {data, nextCursor} envelope. Requires the users:r scope.

    • getUserVersions

      public ModelDataVersionPage getUserVersions(String id, RequestOptions requestOptions)
      Returns the audit trail of changes to a user, most recent first. Identity history is always recorded and always available. Sensitive field values are redacted in every historical version. Returns a page in the {data, nextCursor} envelope. Requires the users:r scope.

    • getUserVersions

      public ModelDataVersionPage getUserVersions(String id, GetUserVersionsRequest request)
      Returns the audit trail of changes to a user, most recent first. Identity history is always recorded and always available. Sensitive field values are redacted in every historical version. Returns a page in the {data, nextCursor} envelope. Requires the users:r scope.

    • getUserVersions

      public ModelDataVersionPage getUserVersions(String id, GetUserVersionsRequest request, RequestOptions requestOptions)
      Returns the audit trail of changes to a user, most recent first. Identity history is always recorded and always available. Sensitive field values are redacted in every historical version. Returns a page in the {data, nextCursor} envelope. Requires the users:r scope.