Package ai.vectros.resources.auth

Class RawAuthClient

java.lang.Object

ai.vectros.resources.auth.RawAuthClient

public class RawAuthClient
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawAuthClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
VectrosApiHttpResponse<AccessProfileResponse>	createAccessProfile(String contextId, CreateAccessProfileRequest request)	Creates a new access profile under the given app context.
VectrosApiHttpResponse<AccessProfileResponse>	createAccessProfile(String contextId, CreateAccessProfileRequest request, RequestOptions requestOptions)	Creates a new access profile under the given app context.
VectrosApiHttpResponse<AccessProfileResponse>	createAccessProfile(String contextId, AccessProfileRequest body)	Creates a new access profile under the given app context.
VectrosApiHttpResponse<AccessProfileResponse>	createAccessProfile(String contextId, AccessProfileRequest body, RequestOptions requestOptions)	Creates a new access profile under the given app context.
VectrosApiHttpResponse<AppContextResponse>	createAppContext(CreateAppContextRequest request)	Creates a new app context.
VectrosApiHttpResponse<AppContextResponse>	createAppContext(CreateAppContextRequest request, RequestOptions requestOptions)	Creates a new app context.
VectrosApiHttpResponse<AppContextResponse>	createAppContext(AppContextRequest body)	Creates a new app context.
VectrosApiHttpResponse<AppContextResponse>	createAppContext(AppContextRequest body, RequestOptions requestOptions)	Creates a new app context.
VectrosApiHttpResponse<CreateInviteResponse>	createInvite(CreateInviteRequest request)	Invite a new member to one of your app contexts by email.
VectrosApiHttpResponse<CreateInviteResponse>	createInvite(CreateInviteRequest request, RequestOptions requestOptions)	Invite a new member to one of your app contexts by email.
VectrosApiHttpResponse<RoleResponse>	createRole(String contextId, CreateRoleRequest request)	Creates a new role under the given app context.
VectrosApiHttpResponse<RoleResponse>	createRole(String contextId, CreateRoleRequest request, RequestOptions requestOptions)	Creates a new role under the given app context.
VectrosApiHttpResponse<RoleResponse>	createRole(String contextId, RoleRequest body)	Creates a new role under the given app context.
VectrosApiHttpResponse<RoleResponse>	createRole(String contextId, RoleRequest body, RequestOptions requestOptions)	Creates a new role under the given app context.
VectrosApiHttpResponse<ScopedKeyResponse>	createScopedKey(CreateScopedKeyRequest request)	Creates a scoped API key (an ssk_* secret) that inherits its permissions from an existing access profile in your account.
VectrosApiHttpResponse<ScopedKeyResponse>	createScopedKey(CreateScopedKeyRequest request, RequestOptions requestOptions)	Creates a scoped API key (an ssk_* secret) that inherits its permissions from an existing access profile in your account.
VectrosApiHttpResponse<Void>	deleteAccessProfile(String contextId, String principalId)	Deletes an access profile.
VectrosApiHttpResponse<Void>	deleteAccessProfile(String contextId, String principalId, RequestOptions requestOptions)	Deletes an access profile.
VectrosApiHttpResponse<Void>	deleteAccessProfile(String contextId, String principalId, DeleteAccessProfileRequest request)	Deletes an access profile.
VectrosApiHttpResponse<Void>	deleteAccessProfile(String contextId, String principalId, DeleteAccessProfileRequest request, RequestOptions requestOptions)	Deletes an access profile.
VectrosApiHttpResponse<Void>	deleteAppContext(String contextId)	Permanently deletes an app context and everything in it — every record, document, folder, schema, role, and access profile belonging to the context.
VectrosApiHttpResponse<Void>	deleteAppContext(String contextId, RequestOptions requestOptions)	Permanently deletes an app context and everything in it — every record, document, folder, schema, role, and access profile belonging to the context.
VectrosApiHttpResponse<Void>	deleteAppContext(String contextId, DeleteAppContextRequest request)	Permanently deletes an app context and everything in it — every record, document, folder, schema, role, and access profile belonging to the context.
VectrosApiHttpResponse<Void>	deleteAppContext(String contextId, DeleteAppContextRequest request, RequestOptions requestOptions)	Permanently deletes an app context and everything in it — every record, document, folder, schema, role, and access profile belonging to the context.
VectrosApiHttpResponse<Void>	deleteRole(String contextId, String roleId)	Deletes a role.
VectrosApiHttpResponse<Void>	deleteRole(String contextId, String roleId, RequestOptions requestOptions)	Deletes a role.
VectrosApiHttpResponse<Void>	deleteRole(String contextId, String roleId, DeleteRoleRequest request)	Deletes a role.
VectrosApiHttpResponse<Void>	deleteRole(String contextId, String roleId, DeleteRoleRequest request, RequestOptions requestOptions)	Deletes a role.
VectrosApiHttpResponse<ReadAccessLogPage>	getAccessLog()	Returns a page of per-subject PHI read-access rows: who read which subject's PHI, when, against which record, and whether any sensitive value was actually revealed in plaintext.
VectrosApiHttpResponse<ReadAccessLogPage>	getAccessLog(RequestOptions requestOptions)	Returns a page of per-subject PHI read-access rows: who read which subject's PHI, when, against which record, and whether any sensitive value was actually revealed in plaintext.
VectrosApiHttpResponse<ReadAccessLogPage>	getAccessLog(GetAccessLogRequest request)	Returns a page of per-subject PHI read-access rows: who read which subject's PHI, when, against which record, and whether any sensitive value was actually revealed in plaintext.
VectrosApiHttpResponse<ReadAccessLogPage>	getAccessLog(GetAccessLogRequest request, RequestOptions requestOptions)	Returns a page of per-subject PHI read-access rows: who read which subject's PHI, when, against which record, and whether any sensitive value was actually revealed in plaintext.
VectrosApiHttpResponse<AccessProfileResponse>	getAccessProfile(String contextId, String principalId)	Returns a single access profile by its principalId within the given app context.
VectrosApiHttpResponse<AccessProfileResponse>	getAccessProfile(String contextId, String principalId, RequestOptions requestOptions)	Returns a single access profile by its principalId within the given app context.
VectrosApiHttpResponse<AccessProfileResponse>	getAccessProfile(String contextId, String principalId, GetAccessProfileRequest request)	Returns a single access profile by its principalId within the given app context.
VectrosApiHttpResponse<AccessProfileResponse>	getAccessProfile(String contextId, String principalId, GetAccessProfileRequest request, RequestOptions requestOptions)	Returns a single access profile by its principalId within the given app context.
VectrosApiHttpResponse<ModelDataVersionPage>	getAccessProfileVersions(String contextId, String principalId)	Returns the audit trail of changes (create, update, and delete events) for an access profile, most recent first.
VectrosApiHttpResponse<ModelDataVersionPage>	getAccessProfileVersions(String contextId, String principalId, RequestOptions requestOptions)	Returns the audit trail of changes (create, update, and delete events) for an access profile, most recent first.
VectrosApiHttpResponse<ModelDataVersionPage>	getAccessProfileVersions(String contextId, String principalId, GetAccessProfileVersionsRequest request)	Returns the audit trail of changes (create, update, and delete events) for an access profile, most recent first.
VectrosApiHttpResponse<ModelDataVersionPage>	getAccessProfileVersions(String contextId, String principalId, GetAccessProfileVersionsRequest request, RequestOptions requestOptions)	Returns the audit trail of changes (create, update, and delete events) for an access profile, most recent first.
VectrosApiHttpResponse<AdminLogsResponse>	getAdminLogs(GetAdminLogsRequest request)	Returns recent API call logs for your account.
VectrosApiHttpResponse<AdminLogsResponse>	getAdminLogs(GetAdminLogsRequest request, RequestOptions requestOptions)	Returns recent API call logs for your account.
VectrosApiHttpResponse<AppContextResponse>	getAppContext(String contextId)	Returns a single app context by its contextId.
VectrosApiHttpResponse<AppContextResponse>	getAppContext(String contextId, RequestOptions requestOptions)	Returns a single app context by its contextId.
VectrosApiHttpResponse<AppContextResponse>	getAppContext(String contextId, GetAppContextRequest request)	Returns a single app context by its contextId.
VectrosApiHttpResponse<AppContextResponse>	getAppContext(String contextId, GetAppContextRequest request, RequestOptions requestOptions)	Returns a single app context by its contextId.
VectrosApiHttpResponse<JwksResponse>	getJwks()	Returns the platform's JWT signing public key in RFC 7517 JWKS format.
VectrosApiHttpResponse<JwksResponse>	getJwks(RequestOptions requestOptions)	Returns the platform's JWT signing public key in RFC 7517 JWKS format.
VectrosApiHttpResponse<RoleResponse>	getRole(String contextId, String roleId)	Returns a single role by its roleId within the given app context.
VectrosApiHttpResponse<RoleResponse>	getRole(String contextId, String roleId, RequestOptions requestOptions)	Returns a single role by its roleId within the given app context.
VectrosApiHttpResponse<RoleResponse>	getRole(String contextId, String roleId, GetRoleRequest request)	Returns a single role by its roleId within the given app context.
VectrosApiHttpResponse<RoleResponse>	getRole(String contextId, String roleId, GetRoleRequest request, RequestOptions requestOptions)	Returns a single role by its roleId within the given app context.
VectrosApiHttpResponse<ModelDataVersionPage>	getRoleVersions(String contextId, String roleId)	Returns the audit trail of changes (create, update, and delete events) for a role, newest first.
VectrosApiHttpResponse<ModelDataVersionPage>	getRoleVersions(String contextId, String roleId, RequestOptions requestOptions)	Returns the audit trail of changes (create, update, and delete events) for a role, newest first.
VectrosApiHttpResponse<ModelDataVersionPage>	getRoleVersions(String contextId, String roleId, GetRoleVersionsRequest request)	Returns the audit trail of changes (create, update, and delete events) for a role, newest first.
VectrosApiHttpResponse<ModelDataVersionPage>	getRoleVersions(String contextId, String roleId, GetRoleVersionsRequest request, RequestOptions requestOptions)	Returns the audit trail of changes (create, update, and delete events) for a role, newest first.
VectrosApiHttpResponse<ScopedKeyResponse>	getScopedKey(String keyId)	Returns the metadata for a single scoped API key.
VectrosApiHttpResponse<ScopedKeyResponse>	getScopedKey(String keyId, RequestOptions requestOptions)	Returns the metadata for a single scoped API key.
VectrosApiHttpResponse<ScopedKeyResponse>	getScopedKey(String keyId, GetScopedKeyRequest request)	Returns the metadata for a single scoped API key.
VectrosApiHttpResponse<ScopedKeyResponse>	getScopedKey(String keyId, GetScopedKeyRequest request, RequestOptions requestOptions)	Returns the metadata for a single scoped API key.
VectrosApiHttpResponse<UsageReportResponse>	getUsage()	Returns full usage detail for the requested calendar month, broken down by category (search, documents, and records) with per-category credit estimates and a split between your live and test environments.
VectrosApiHttpResponse<UsageReportResponse>	getUsage(RequestOptions requestOptions)	Returns full usage detail for the requested calendar month, broken down by category (search, documents, and records) with per-category credit estimates and a split between your live and test environments.
VectrosApiHttpResponse<UsageReportResponse>	getUsage(GetUsageRequest request)	Returns full usage detail for the requested calendar month, broken down by category (search, documents, and records) with per-category credit estimates and a split between your live and test environments.
VectrosApiHttpResponse<UsageReportResponse>	getUsage(GetUsageRequest request, RequestOptions requestOptions)	Returns full usage detail for the requested calendar month, broken down by category (search, documents, and records) with per-category credit estimates and a split between your live and test environments.
VectrosApiHttpResponse<AccessProfilePage>	listAccessProfiles(String contextId)	Returns the access profiles assigned within the given app context — in effect, who has access to this context and with what scopes.
VectrosApiHttpResponse<AccessProfilePage>	listAccessProfiles(String contextId, RequestOptions requestOptions)	Returns the access profiles assigned within the given app context — in effect, who has access to this context and with what scopes.
VectrosApiHttpResponse<AccessProfilePage>	listAccessProfiles(String contextId, ListAccessProfilesRequest request)	Returns the access profiles assigned within the given app context — in effect, who has access to this context and with what scopes.
VectrosApiHttpResponse<AccessProfilePage>	listAccessProfiles(String contextId, ListAccessProfilesRequest request, RequestOptions requestOptions)	Returns the access profiles assigned within the given app context — in effect, who has access to this context and with what scopes.
VectrosApiHttpResponse<AppContextPage>	listAppContexts()	Returns a paginated list of the app contexts in your account.
VectrosApiHttpResponse<AppContextPage>	listAppContexts(RequestOptions requestOptions)	Returns a paginated list of the app contexts in your account.
VectrosApiHttpResponse<AppContextPage>	listAppContexts(ListAppContextsRequest request)	Returns a paginated list of the app contexts in your account.
VectrosApiHttpResponse<AppContextPage>	listAppContexts(ListAppContextsRequest request, RequestOptions requestOptions)	Returns a paginated list of the app contexts in your account.
VectrosApiHttpResponse<AccessProfilePage>	listProfilesForPrincipal(String principalId)	Returns the access profiles for the given principal across all of your contexts.
VectrosApiHttpResponse<AccessProfilePage>	listProfilesForPrincipal(String principalId, RequestOptions requestOptions)	Returns the access profiles for the given principal across all of your contexts.
VectrosApiHttpResponse<AccessProfilePage>	listProfilesForPrincipal(String principalId, ListProfilesForPrincipalRequest request)	Returns the access profiles for the given principal across all of your contexts.
VectrosApiHttpResponse<AccessProfilePage>	listProfilesForPrincipal(String principalId, ListProfilesForPrincipalRequest request, RequestOptions requestOptions)	Returns the access profiles for the given principal across all of your contexts.
VectrosApiHttpResponse<RolePage>	listRoles(String contextId)	Returns the roles defined under the given app context.
VectrosApiHttpResponse<RolePage>	listRoles(String contextId, RequestOptions requestOptions)	Returns the roles defined under the given app context.
VectrosApiHttpResponse<RolePage>	listRoles(String contextId, ListRolesRequest request)	Returns the roles defined under the given app context.
VectrosApiHttpResponse<RolePage>	listRoles(String contextId, ListRolesRequest request, RequestOptions requestOptions)	Returns the roles defined under the given app context.
VectrosApiHttpResponse<ScopedKeyPage>	listScopedKeys()	Lists all of your scoped API keys (ssk_*) across both your live and test environments.
VectrosApiHttpResponse<ScopedKeyPage>	listScopedKeys(RequestOptions requestOptions)	Lists all of your scoped API keys (ssk_*) across both your live and test environments.
VectrosApiHttpResponse<MintTokenResponse>	mintToken(TokenRequest request)	Creates a short-lived JWT bearer token restricted to specific actions and, optionally, to a particular user or identity entity (in any namespace).
VectrosApiHttpResponse<MintTokenResponse>	mintToken(TokenRequest request, RequestOptions requestOptions)	Creates a short-lived JWT bearer token restricted to specific actions and, optionally, to a particular user or identity entity (in any namespace).
VectrosApiHttpResponse<PingResponse>	ping()	Returns the identity bound to your credential — your account, principal type, key id, and scope details — so you can confirm who you are authenticated as and that the credential is valid.
VectrosApiHttpResponse<PingResponse>	ping(RequestOptions requestOptions)	Returns the identity bound to your credential — your account, principal type, key id, and scope details — so you can confirm who you are authenticated as and that the credential is valid.
VectrosApiHttpResponse<CreateInviteResponse>	resendInvite(CreateInviteRequest request)	Resend an outstanding invitation, identified by its email and app context.
VectrosApiHttpResponse<CreateInviteResponse>	resendInvite(CreateInviteRequest request, RequestOptions requestOptions)	Resend an outstanding invitation, identified by its email and app context.
VectrosApiHttpResponse<Void>	revokeScopedKey(String keyId)	Revokes a scoped API key.
VectrosApiHttpResponse<Void>	revokeScopedKey(String keyId, RequestOptions requestOptions)	Revokes a scoped API key.
VectrosApiHttpResponse<Void>	revokeScopedKey(String keyId, RevokeScopedKeyRequest request)	Revokes a scoped API key.
VectrosApiHttpResponse<Void>	revokeScopedKey(String keyId, RevokeScopedKeyRequest request, RequestOptions requestOptions)	Revokes a scoped API key.
VectrosApiHttpResponse<AccessProfileResponse>	updateAccessProfile(String contextId, String principalId, UpdateAccessProfileRequest request)	Updates an access profile.
VectrosApiHttpResponse<AccessProfileResponse>	updateAccessProfile(String contextId, String principalId, UpdateAccessProfileRequest request, RequestOptions requestOptions)	Updates an access profile.
VectrosApiHttpResponse<AppContextResponse>	updateAppContext(String contextId, UpdateAppContextRequest request)	Updates the name and/or description of an app context.
VectrosApiHttpResponse<AppContextResponse>	updateAppContext(String contextId, UpdateAppContextRequest request, RequestOptions requestOptions)	Updates the name and/or description of an app context.
VectrosApiHttpResponse<RoleResponse>	updateRole(String contextId, String roleId, UpdateRoleRequest request)	Updates a role.
VectrosApiHttpResponse<RoleResponse>	updateRole(String contextId, String roleId, UpdateRoleRequest request, RequestOptions requestOptions)	Updates a role.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

clientOptions

protected final ClientOptions clientOptions

Constructor Details

RawAuthClient

public RawAuthClient(ClientOptions clientOptions)

Method Details

getJwks

public VectrosApiHttpResponse<JwksResponse> getJwks()

Returns the platform's JWT signing public key in RFC 7517 JWKS format. Use it with any JWKS-aware JWT library to verify inv_* invite tokens, st_* scoped tokens, and other platform-signed tokens locally, without calling back to the API for each verification. The response carries a one-hour Cache-Control, so cache it and re-fetch roughly hourly rather than on every verification. The kid value changes when the key rotates; re-fetch this document whenever you encounter a token signed with an unknown kid.

getJwks

public VectrosApiHttpResponse<JwksResponse> getJwks(RequestOptions requestOptions)

Returns the platform's JWT signing public key in RFC 7517 JWKS format. Use it with any JWKS-aware JWT library to verify inv_* invite tokens, st_* scoped tokens, and other platform-signed tokens locally, without calling back to the API for each verification. The response carries a one-hour Cache-Control, so cache it and re-fetch roughly hourly rather than on every verification. The kid value changes when the key rotates; re-fetch this document whenever you encounter a token signed with an unknown kid.

getAccessLog

public VectrosApiHttpResponse<ReadAccessLogPage> getAccessLog()

Returns a page of per-subject PHI read-access rows: who read which subject's PHI, when, against which record, and whether any sensitive value was actually revealed in plaintext. Metadata only — never the PHI itself. This is the disclosure-accounting surface from which a covered entity derives its HIPAA §164.528 accounting of disclosures. Provide at least one query axis: a subject (subjectType + subjectId) within a contextId for the primary accounting query; resourceId within a contextId for 'who read this record'; callerKeyId for 'what did this credential read' (account-wide forensic); or contextId alone to enumerate a whole context. from/to bound the time window. Results are scoped to your account, derived from your token — never from input. Requires the access-log:r scope.

getAccessLog

public VectrosApiHttpResponse<ReadAccessLogPage> getAccessLog(RequestOptions requestOptions)

Returns a page of per-subject PHI read-access rows: who read which subject's PHI, when, against which record, and whether any sensitive value was actually revealed in plaintext. Metadata only — never the PHI itself. This is the disclosure-accounting surface from which a covered entity derives its HIPAA §164.528 accounting of disclosures. Provide at least one query axis: a subject (subjectType + subjectId) within a contextId for the primary accounting query; resourceId within a contextId for 'who read this record'; callerKeyId for 'what did this credential read' (account-wide forensic); or contextId alone to enumerate a whole context. from/to bound the time window. Results are scoped to your account, derived from your token — never from input. Requires the access-log:r scope.

getAccessLog

public VectrosApiHttpResponse<ReadAccessLogPage> getAccessLog(GetAccessLogRequest request)

Returns a page of per-subject PHI read-access rows: who read which subject's PHI, when, against which record, and whether any sensitive value was actually revealed in plaintext. Metadata only — never the PHI itself. This is the disclosure-accounting surface from which a covered entity derives its HIPAA §164.528 accounting of disclosures. Provide at least one query axis: a subject (subjectType + subjectId) within a contextId for the primary accounting query; resourceId within a contextId for 'who read this record'; callerKeyId for 'what did this credential read' (account-wide forensic); or contextId alone to enumerate a whole context. from/to bound the time window. Results are scoped to your account, derived from your token — never from input. Requires the access-log:r scope.

getAccessLog

public VectrosApiHttpResponse<ReadAccessLogPage> getAccessLog(GetAccessLogRequest request,
 RequestOptions requestOptions)

Returns a page of per-subject PHI read-access rows: who read which subject's PHI, when, against which record, and whether any sensitive value was actually revealed in plaintext. Metadata only — never the PHI itself. This is the disclosure-accounting surface from which a covered entity derives its HIPAA §164.528 accounting of disclosures. Provide at least one query axis: a subject (subjectType + subjectId) within a contextId for the primary accounting query; resourceId within a contextId for 'who read this record'; callerKeyId for 'what did this credential read' (account-wide forensic); or contextId alone to enumerate a whole context. from/to bound the time window. Results are scoped to your account, derived from your token — never from input. Requires the access-log:r scope.

listScopedKeys

public VectrosApiHttpResponse<ScopedKeyPage> listScopedKeys()

Lists all of your scoped API keys (ssk_*) across both your live and test environments. Revoked keys are excluded. Requires the keys:r scope.

listScopedKeys

public VectrosApiHttpResponse<ScopedKeyPage> listScopedKeys(RequestOptions requestOptions)

Lists all of your scoped API keys (ssk_*) across both your live and test environments. Revoked keys are excluded. Requires the keys:r scope.

createScopedKey

public VectrosApiHttpResponse<ScopedKeyResponse> createScopedKey(CreateScopedKeyRequest request)

Creates a scoped API key (an ssk_* secret) that inherits its permissions from an existing access profile in your account. The call is idempotent on the combination of tenant, context, user, and key name: re-issuing the same request returns the existing key WITHOUT re-disclosing its raw secret. The raw key is returned ONLY in this response — store it securely, as it cannot be retrieved again. Requires the keys:c scope.

createScopedKey

public VectrosApiHttpResponse<ScopedKeyResponse> createScopedKey(CreateScopedKeyRequest request,
 RequestOptions requestOptions)

Creates a scoped API key (an ssk_* secret) that inherits its permissions from an existing access profile in your account. The call is idempotent on the combination of tenant, context, user, and key name: re-issuing the same request returns the existing key WITHOUT re-disclosing its raw secret. The raw key is returned ONLY in this response — store it securely, as it cannot be retrieved again. Requires the keys:c scope.

getScopedKey

public VectrosApiHttpResponse<ScopedKeyResponse> getScopedKey(String keyId)

Returns the metadata for a single scoped API key. The raw secret is NOT included — it is only ever returned once, when the key is first created. Requires the keys:r scope.

getScopedKey

public VectrosApiHttpResponse<ScopedKeyResponse> getScopedKey(String keyId,
 RequestOptions requestOptions)

Returns the metadata for a single scoped API key. The raw secret is NOT included — it is only ever returned once, when the key is first created. Requires the keys:r scope.

getScopedKey

public VectrosApiHttpResponse<ScopedKeyResponse> getScopedKey(String keyId,
 GetScopedKeyRequest request)

Returns the metadata for a single scoped API key. The raw secret is NOT included — it is only ever returned once, when the key is first created. Requires the keys:r scope.

getScopedKey

public VectrosApiHttpResponse<ScopedKeyResponse> getScopedKey(String keyId,
 GetScopedKeyRequest request,
 RequestOptions requestOptions)

Returns the metadata for a single scoped API key. The raw secret is NOT included — it is only ever returned once, when the key is first created. Requires the keys:r scope.

revokeScopedKey

public VectrosApiHttpResponse<Void> revokeScopedKey(String keyId)

Revokes a scoped API key. Its status changes to revoked and it stops working within about 5 minutes, the maximum time authorization is cached. Revocation is permanent. Requires the keys:d scope.

revokeScopedKey

public VectrosApiHttpResponse<Void> revokeScopedKey(String keyId,
 RequestOptions requestOptions)

Revokes a scoped API key. Its status changes to revoked and it stops working within about 5 minutes, the maximum time authorization is cached. Revocation is permanent. Requires the keys:d scope.

revokeScopedKey

public VectrosApiHttpResponse<Void> revokeScopedKey(String keyId,
 RevokeScopedKeyRequest request)

Revokes a scoped API key. Its status changes to revoked and it stops working within about 5 minutes, the maximum time authorization is cached. Revocation is permanent. Requires the keys:d scope.

revokeScopedKey

public VectrosApiHttpResponse<Void> revokeScopedKey(String keyId,
 RevokeScopedKeyRequest request,
 RequestOptions requestOptions)

Revokes a scoped API key. Its status changes to revoked and it stops working within about 5 minutes, the maximum time authorization is cached. Revocation is permanent. Requires the keys:d scope.

getAdminLogs

public VectrosApiHttpResponse<AdminLogsResponse> getAdminLogs(GetAdminLogsRequest request)

Returns recent API call logs for your account. Each entry represents one API request; request and response bodies are never logged. startTime and endTime must be ISO-8601 UTC (e.g. 2025-01-15T09:00:00Z); endTime defaults to now. Filter by resource, method, key id, or context id, or set errorsOnly to see only failures. Results are scoped to your account, derived from your token — never from input. Requires the logs:r scope.

getAdminLogs

public VectrosApiHttpResponse<AdminLogsResponse> getAdminLogs(GetAdminLogsRequest request,
 RequestOptions requestOptions)

Returns recent API call logs for your account. Each entry represents one API request; request and response bodies are never logged. startTime and endTime must be ISO-8601 UTC (e.g. 2025-01-15T09:00:00Z); endTime defaults to now. Filter by resource, method, key id, or context id, or set errorsOnly to see only failures. Results are scoped to your account, derived from your token — never from input. Requires the logs:r scope.

listAccessProfiles

public VectrosApiHttpResponse<AccessProfilePage> listAccessProfiles(String contextId)

Returns the access profiles assigned within the given app context — in effect, who has access to this context and with what scopes. Each profile binds a principal to either a set of inline scopes or a referenced role. Results are paginated. Requires the profiles:r scope.

listAccessProfiles

public VectrosApiHttpResponse<AccessProfilePage> listAccessProfiles(String contextId,
 RequestOptions requestOptions)

Returns the access profiles assigned within the given app context — in effect, who has access to this context and with what scopes. Each profile binds a principal to either a set of inline scopes or a referenced role. Results are paginated. Requires the profiles:r scope.

listAccessProfiles

public VectrosApiHttpResponse<AccessProfilePage> listAccessProfiles(String contextId,
 ListAccessProfilesRequest request)

Returns the access profiles assigned within the given app context — in effect, who has access to this context and with what scopes. Each profile binds a principal to either a set of inline scopes or a referenced role. Results are paginated. Requires the profiles:r scope.

listAccessProfiles

public VectrosApiHttpResponse<AccessProfilePage> listAccessProfiles(String contextId,
 ListAccessProfilesRequest request,
 RequestOptions requestOptions)

Returns the access profiles assigned within the given app context — in effect, who has access to this context and with what scopes. Each profile binds a principal to either a set of inline scopes or a referenced role. Results are paginated. Requires the profiles:r scope.

createAccessProfile

public VectrosApiHttpResponse<AccessProfileResponse> createAccessProfile(String contextId,
 AccessProfileRequest body)

Creates a new access profile under the given app context. This call is idempotent by principalId: if a profile with the same principalId already exists, the existing profile is returned (with status 200) instead of creating a duplicate. The response's created field (and the HTTP status — 201 when created, 200 when an existing profile was returned) tells the two apart. To overwrite an existing profile's scopes/roleId, identityOverrides, and status instead of returning it unchanged, set ?upsert=true (this also requires the profiles:u scope). You must provide exactly one of scopes (an inline list of scopes) or roleId (a reference to a role); supplying both, or neither, is rejected. identityOverrides is keyed by ownership namespace in scope:<namespace> form — scope:org and scope:client for the reserved namespaces, or any namespace you have registered — and may name at most two; any other key (including the account identifier or userId) is rejected. If you use a scoped credential, the profile's effective scopes may not exceed your own; a root API key (sk_) is exempt. Requires the profiles:c scope.

createAccessProfile

public VectrosApiHttpResponse<AccessProfileResponse> createAccessProfile(String contextId,
 AccessProfileRequest body,
 RequestOptions requestOptions)

Creates a new access profile under the given app context. This call is idempotent by principalId: if a profile with the same principalId already exists, the existing profile is returned (with status 200) instead of creating a duplicate. The response's created field (and the HTTP status — 201 when created, 200 when an existing profile was returned) tells the two apart. To overwrite an existing profile's scopes/roleId, identityOverrides, and status instead of returning it unchanged, set ?upsert=true (this also requires the profiles:u scope). You must provide exactly one of scopes (an inline list of scopes) or roleId (a reference to a role); supplying both, or neither, is rejected. identityOverrides is keyed by ownership namespace in scope:<namespace> form — scope:org and scope:client for the reserved namespaces, or any namespace you have registered — and may name at most two; any other key (including the account identifier or userId) is rejected. If you use a scoped credential, the profile's effective scopes may not exceed your own; a root API key (sk_) is exempt. Requires the profiles:c scope.

createAccessProfile

public VectrosApiHttpResponse<AccessProfileResponse> createAccessProfile(String contextId,
 CreateAccessProfileRequest request)

Creates a new access profile under the given app context. This call is idempotent by principalId: if a profile with the same principalId already exists, the existing profile is returned (with status 200) instead of creating a duplicate. The response's created field (and the HTTP status — 201 when created, 200 when an existing profile was returned) tells the two apart. To overwrite an existing profile's scopes/roleId, identityOverrides, and status instead of returning it unchanged, set ?upsert=true (this also requires the profiles:u scope). You must provide exactly one of scopes (an inline list of scopes) or roleId (a reference to a role); supplying both, or neither, is rejected. identityOverrides is keyed by ownership namespace in scope:<namespace> form — scope:org and scope:client for the reserved namespaces, or any namespace you have registered — and may name at most two; any other key (including the account identifier or userId) is rejected. If you use a scoped credential, the profile's effective scopes may not exceed your own; a root API key (sk_) is exempt. Requires the profiles:c scope.

createAccessProfile

public VectrosApiHttpResponse<AccessProfileResponse> createAccessProfile(String contextId,
 CreateAccessProfileRequest request,
 RequestOptions requestOptions)

Creates a new access profile under the given app context. This call is idempotent by principalId: if a profile with the same principalId already exists, the existing profile is returned (with status 200) instead of creating a duplicate. The response's created field (and the HTTP status — 201 when created, 200 when an existing profile was returned) tells the two apart. To overwrite an existing profile's scopes/roleId, identityOverrides, and status instead of returning it unchanged, set ?upsert=true (this also requires the profiles:u scope). You must provide exactly one of scopes (an inline list of scopes) or roleId (a reference to a role); supplying both, or neither, is rejected. identityOverrides is keyed by ownership namespace in scope:<namespace> form — scope:org and scope:client for the reserved namespaces, or any namespace you have registered — and may name at most two; any other key (including the account identifier or userId) is rejected. If you use a scoped credential, the profile's effective scopes may not exceed your own; a root API key (sk_) is exempt. Requires the profiles:c scope.

listAppContexts

public VectrosApiHttpResponse<AppContextPage> listAppContexts()

Returns a paginated list of the app contexts in your account. Each app context is a namespace that groups the access profiles and roles for one of your applications. Requires the app-contexts:r scope.

listAppContexts

public VectrosApiHttpResponse<AppContextPage> listAppContexts(RequestOptions requestOptions)

Returns a paginated list of the app contexts in your account. Each app context is a namespace that groups the access profiles and roles for one of your applications. Requires the app-contexts:r scope.

listAppContexts

public VectrosApiHttpResponse<AppContextPage> listAppContexts(ListAppContextsRequest request)

Returns a paginated list of the app contexts in your account. Each app context is a namespace that groups the access profiles and roles for one of your applications. Requires the app-contexts:r scope.

listAppContexts

public VectrosApiHttpResponse<AppContextPage> listAppContexts(ListAppContextsRequest request,
 RequestOptions requestOptions)

Returns a paginated list of the app contexts in your account. Each app context is a namespace that groups the access profiles and roles for one of your applications. Requires the app-contexts:r scope.

createAppContext

public VectrosApiHttpResponse<AppContextResponse> createAppContext(AppContextRequest body)

Creates a new app context. This call is idempotent by contextId: if an app context with the same contextId already exists, the existing app context is returned (with status 200) instead of creating a duplicate. The response's created field (and the HTTP status — 201 when created, 200 when an existing context was returned) tells the two apart. To overwrite an existing context's name/description instead of returning it unchanged, set ?upsert=true (this also requires the app-contexts:u scope). The reserved contextId value vectros-admin cannot be created through this endpoint; it is provisioned automatically for your account. Requires the app-contexts:c scope.

createAppContext

public VectrosApiHttpResponse<AppContextResponse> createAppContext(AppContextRequest body,
 RequestOptions requestOptions)

Creates a new app context. This call is idempotent by contextId: if an app context with the same contextId already exists, the existing app context is returned (with status 200) instead of creating a duplicate. The response's created field (and the HTTP status — 201 when created, 200 when an existing context was returned) tells the two apart. To overwrite an existing context's name/description instead of returning it unchanged, set ?upsert=true (this also requires the app-contexts:u scope). The reserved contextId value vectros-admin cannot be created through this endpoint; it is provisioned automatically for your account. Requires the app-contexts:c scope.

createAppContext

public VectrosApiHttpResponse<AppContextResponse> createAppContext(CreateAppContextRequest request)

Creates a new app context. This call is idempotent by contextId: if an app context with the same contextId already exists, the existing app context is returned (with status 200) instead of creating a duplicate. The response's created field (and the HTTP status — 201 when created, 200 when an existing context was returned) tells the two apart. To overwrite an existing context's name/description instead of returning it unchanged, set ?upsert=true (this also requires the app-contexts:u scope). The reserved contextId value vectros-admin cannot be created through this endpoint; it is provisioned automatically for your account. Requires the app-contexts:c scope.

createAppContext

public VectrosApiHttpResponse<AppContextResponse> createAppContext(CreateAppContextRequest request,
 RequestOptions requestOptions)

Creates a new app context. This call is idempotent by contextId: if an app context with the same contextId already exists, the existing app context is returned (with status 200) instead of creating a duplicate. The response's created field (and the HTTP status — 201 when created, 200 when an existing context was returned) tells the two apart. To overwrite an existing context's name/description instead of returning it unchanged, set ?upsert=true (this also requires the app-contexts:u scope). The reserved contextId value vectros-admin cannot be created through this endpoint; it is provisioned automatically for your account. Requires the app-contexts:c scope.

listRoles

public VectrosApiHttpResponse<RolePage> listRoles(String contextId)

Returns the roles defined under the given app context. A role is a reusable, named bundle of scopes that access profiles can reference instead of listing scopes inline. Results are paginated. Requires the profiles:r scope.

listRoles

public VectrosApiHttpResponse<RolePage> listRoles(String contextId,
 RequestOptions requestOptions)

Returns the roles defined under the given app context. A role is a reusable, named bundle of scopes that access profiles can reference instead of listing scopes inline. Results are paginated. Requires the profiles:r scope.

listRoles

public VectrosApiHttpResponse<RolePage> listRoles(String contextId,
 ListRolesRequest request)

Returns the roles defined under the given app context. A role is a reusable, named bundle of scopes that access profiles can reference instead of listing scopes inline. Results are paginated. Requires the profiles:r scope.

listRoles

public VectrosApiHttpResponse<RolePage> listRoles(String contextId,
 ListRolesRequest request,
 RequestOptions requestOptions)

Returns the roles defined under the given app context. A role is a reusable, named bundle of scopes that access profiles can reference instead of listing scopes inline. Results are paginated. Requires the profiles:r scope.

createRole

public VectrosApiHttpResponse<RoleResponse> createRole(String contextId,
 RoleRequest body)

Creates a new role under the given app context. This call is idempotent by roleId: if a role with the same roleId already exists, the existing role is returned (with status 200) instead of creating a duplicate. The response's created field (and the HTTP status — 201 when created, 200 when an existing role was returned) tells the two apart. To overwrite an existing role's name/description/scopes instead of returning it unchanged, set ?upsert=true (this also requires the profiles:u scope). If you use a scoped credential, the role's scopes may not exceed your own; a root API key (sk_) is exempt. Requires the profiles:c scope.

createRole

public VectrosApiHttpResponse<RoleResponse> createRole(String contextId,
 RoleRequest body,
 RequestOptions requestOptions)

Creates a new role under the given app context. This call is idempotent by roleId: if a role with the same roleId already exists, the existing role is returned (with status 200) instead of creating a duplicate. The response's created field (and the HTTP status — 201 when created, 200 when an existing role was returned) tells the two apart. To overwrite an existing role's name/description/scopes instead of returning it unchanged, set ?upsert=true (this also requires the profiles:u scope). If you use a scoped credential, the role's scopes may not exceed your own; a root API key (sk_) is exempt. Requires the profiles:c scope.

createRole

public VectrosApiHttpResponse<RoleResponse> createRole(String contextId,
 CreateRoleRequest request)

Creates a new role under the given app context. This call is idempotent by roleId: if a role with the same roleId already exists, the existing role is returned (with status 200) instead of creating a duplicate. The response's created field (and the HTTP status — 201 when created, 200 when an existing role was returned) tells the two apart. To overwrite an existing role's name/description/scopes instead of returning it unchanged, set ?upsert=true (this also requires the profiles:u scope). If you use a scoped credential, the role's scopes may not exceed your own; a root API key (sk_) is exempt. Requires the profiles:c scope.

createRole

public VectrosApiHttpResponse<RoleResponse> createRole(String contextId,
 CreateRoleRequest request,
 RequestOptions requestOptions)

Creates a new role under the given app context. This call is idempotent by roleId: if a role with the same roleId already exists, the existing role is returned (with status 200) instead of creating a duplicate. The response's created field (and the HTTP status — 201 when created, 200 when an existing role was returned) tells the two apart. To overwrite an existing role's name/description/scopes instead of returning it unchanged, set ?upsert=true (this also requires the profiles:u scope). If you use a scoped credential, the role's scopes may not exceed your own; a root API key (sk_) is exempt. Requires the profiles:c scope.

getAccessProfile

public VectrosApiHttpResponse<AccessProfileResponse> getAccessProfile(String contextId,
 String principalId)

Returns a single access profile by its principalId within the given app context. Requires the profiles:r scope.

getAccessProfile

public VectrosApiHttpResponse<AccessProfileResponse> getAccessProfile(String contextId,
 String principalId,
 RequestOptions requestOptions)

Returns a single access profile by its principalId within the given app context. Requires the profiles:r scope.

getAccessProfile

public VectrosApiHttpResponse<AccessProfileResponse> getAccessProfile(String contextId,
 String principalId,
 GetAccessProfileRequest request)

Returns a single access profile by its principalId within the given app context. Requires the profiles:r scope.

getAccessProfile

public VectrosApiHttpResponse<AccessProfileResponse> getAccessProfile(String contextId,
 String principalId,
 GetAccessProfileRequest request,
 RequestOptions requestOptions)

Returns a single access profile by its principalId within the given app context. Requires the profiles:r scope.

updateAccessProfile

public VectrosApiHttpResponse<AccessProfileResponse> updateAccessProfile(String contextId,
 String principalId,
 UpdateAccessProfileRequest request)

Updates an access profile. This is a partial update: any field you omit (or send as null) keeps its existing value. A profile must reference either inline scopes or a roleId, never both — so setting scopes clears any roleId, and setting roleId clears any inline scopes. The contextId and principalId are immutable. Status changes (for example active to suspended) take effect within about five minutes. If you use a scoped credential, the profile's effective scopes may not exceed your own; a root API key (sk_) is exempt. Requires the profiles:u scope.

updateAccessProfile

public VectrosApiHttpResponse<AccessProfileResponse> updateAccessProfile(String contextId,
 String principalId,
 UpdateAccessProfileRequest request,
 RequestOptions requestOptions)

Updates an access profile. This is a partial update: any field you omit (or send as null) keeps its existing value. A profile must reference either inline scopes or a roleId, never both — so setting scopes clears any roleId, and setting roleId clears any inline scopes. The contextId and principalId are immutable. Status changes (for example active to suspended) take effect within about five minutes. If you use a scoped credential, the profile's effective scopes may not exceed your own; a root API key (sk_) is exempt. Requires the profiles:u scope.

deleteAccessProfile

public VectrosApiHttpResponse<Void> deleteAccessProfile(String contextId,
 String principalId)

Deletes an access profile. Within about five minutes (the access-profile cache lifetime), token minting for this principal in this context will be denied. Requires the profiles:d scope.

deleteAccessProfile

public VectrosApiHttpResponse<Void> deleteAccessProfile(String contextId,
 String principalId,
 RequestOptions requestOptions)

Deletes an access profile. Within about five minutes (the access-profile cache lifetime), token minting for this principal in this context will be denied. Requires the profiles:d scope.

deleteAccessProfile

public VectrosApiHttpResponse<Void> deleteAccessProfile(String contextId,
 String principalId,
 DeleteAccessProfileRequest request)

Deletes an access profile. Within about five minutes (the access-profile cache lifetime), token minting for this principal in this context will be denied. Requires the profiles:d scope.

deleteAccessProfile

public VectrosApiHttpResponse<Void> deleteAccessProfile(String contextId,
 String principalId,
 DeleteAccessProfileRequest request,
 RequestOptions requestOptions)

Deletes an access profile. Within about five minutes (the access-profile cache lifetime), token minting for this principal in this context will be denied. Requires the profiles:d scope.

getAppContext

public VectrosApiHttpResponse<AppContextResponse> getAppContext(String contextId)

Returns a single app context by its contextId. Requires the app-contexts:r scope.

getAppContext

public VectrosApiHttpResponse<AppContextResponse> getAppContext(String contextId,
 RequestOptions requestOptions)

Returns a single app context by its contextId. Requires the app-contexts:r scope.

getAppContext

public VectrosApiHttpResponse<AppContextResponse> getAppContext(String contextId,
 GetAppContextRequest request)

Returns a single app context by its contextId. Requires the app-contexts:r scope.

getAppContext

public VectrosApiHttpResponse<AppContextResponse> getAppContext(String contextId,
 GetAppContextRequest request,
 RequestOptions requestOptions)

Returns a single app context by its contextId. Requires the app-contexts:r scope.

updateAppContext

public VectrosApiHttpResponse<AppContextResponse> updateAppContext(String contextId,
 UpdateAppContextRequest request)

Updates the name and/or description of an app context. This is a partial update: any field you omit (or send as null) keeps its existing value. The contextId is immutable and is taken from the URL path, so any contextId in the request body is ignored. Requires the app-contexts:u scope.

updateAppContext

public VectrosApiHttpResponse<AppContextResponse> updateAppContext(String contextId,
 UpdateAppContextRequest request,
 RequestOptions requestOptions)

Updates the name and/or description of an app context. This is a partial update: any field you omit (or send as null) keeps its existing value. The contextId is immutable and is taken from the URL path, so any contextId in the request body is ignored. Requires the app-contexts:u scope.

deleteAppContext

public VectrosApiHttpResponse<Void> deleteAppContext(String contextId)

Permanently deletes an app context and everything in it — every record, document, folder, schema, role, and access profile belonging to the context. This is irreversible. The deletion runs asynchronously: the call returns 202 immediately and the context's data drains in the background. Poll the context's status field to observe when the teardown completes (purging while draining, then deleted). To guard against accidental deletion, you must echo the contextId back in the confirm query parameter (?confirm={contextId}). The reserved default and vectros-admin contexts cannot be deleted. This operation requires a root API key (one beginning with sk_): no scoped credential, not even one with full wildcard (*) scope, can trigger this teardown.

deleteAppContext

public VectrosApiHttpResponse<Void> deleteAppContext(String contextId,
 RequestOptions requestOptions)

Permanently deletes an app context and everything in it — every record, document, folder, schema, role, and access profile belonging to the context. This is irreversible. The deletion runs asynchronously: the call returns 202 immediately and the context's data drains in the background. Poll the context's status field to observe when the teardown completes (purging while draining, then deleted). To guard against accidental deletion, you must echo the contextId back in the confirm query parameter (?confirm={contextId}). The reserved default and vectros-admin contexts cannot be deleted. This operation requires a root API key (one beginning with sk_): no scoped credential, not even one with full wildcard (*) scope, can trigger this teardown.

deleteAppContext

public VectrosApiHttpResponse<Void> deleteAppContext(String contextId,
 DeleteAppContextRequest request)

Permanently deletes an app context and everything in it — every record, document, folder, schema, role, and access profile belonging to the context. This is irreversible. The deletion runs asynchronously: the call returns 202 immediately and the context's data drains in the background. Poll the context's status field to observe when the teardown completes (purging while draining, then deleted). To guard against accidental deletion, you must echo the contextId back in the confirm query parameter (?confirm={contextId}). The reserved default and vectros-admin contexts cannot be deleted. This operation requires a root API key (one beginning with sk_): no scoped credential, not even one with full wildcard (*) scope, can trigger this teardown.

deleteAppContext

public VectrosApiHttpResponse<Void> deleteAppContext(String contextId,
 DeleteAppContextRequest request,
 RequestOptions requestOptions)

Permanently deletes an app context and everything in it — every record, document, folder, schema, role, and access profile belonging to the context. This is irreversible. The deletion runs asynchronously: the call returns 202 immediately and the context's data drains in the background. Poll the context's status field to observe when the teardown completes (purging while draining, then deleted). To guard against accidental deletion, you must echo the contextId back in the confirm query parameter (?confirm={contextId}). The reserved default and vectros-admin contexts cannot be deleted. This operation requires a root API key (one beginning with sk_): no scoped credential, not even one with full wildcard (*) scope, can trigger this teardown.

getRole

public VectrosApiHttpResponse<RoleResponse> getRole(String contextId,
 String roleId)

Returns a single role by its roleId within the given app context. Requires the profiles:r scope.

getRole

public VectrosApiHttpResponse<RoleResponse> getRole(String contextId,
 String roleId,
 RequestOptions requestOptions)

Returns a single role by its roleId within the given app context. Requires the profiles:r scope.

getRole

public VectrosApiHttpResponse<RoleResponse> getRole(String contextId,
 String roleId,
 GetRoleRequest request)

Returns a single role by its roleId within the given app context. Requires the profiles:r scope.

getRole

public VectrosApiHttpResponse<RoleResponse> getRole(String contextId,
 String roleId,
 GetRoleRequest request,
 RequestOptions requestOptions)

Returns a single role by its roleId within the given app context. Requires the profiles:r scope.

updateRole

public VectrosApiHttpResponse<RoleResponse> updateRole(String contextId,
 String roleId,
 UpdateRoleRequest request)

Updates a role. This is a partial update: any field you omit (or send as null) keeps its existing value. The roleId and contextId are immutable. Scope changes take effect for access profiles that reference this role within about five minutes. If you use a scoped credential, the role's scopes may not exceed your own; a root API key (sk_) is exempt. Requires the profiles:u scope.

updateRole

public VectrosApiHttpResponse<RoleResponse> updateRole(String contextId,
 String roleId,
 UpdateRoleRequest request,
 RequestOptions requestOptions)

Updates a role. This is a partial update: any field you omit (or send as null) keeps its existing value. The roleId and contextId are immutable. Scope changes take effect for access profiles that reference this role within about five minutes. If you use a scoped credential, the role's scopes may not exceed your own; a root API key (sk_) is exempt. Requires the profiles:u scope.

deleteRole

public VectrosApiHttpResponse<Void> deleteRole(String contextId,
 String roleId)

Deletes a role. A role that is still referenced by one or more access profiles cannot be deleted: the request is rejected with 409. Reassign or delete those profiles first, then retry. Requires the profiles:d scope.

deleteRole

public VectrosApiHttpResponse<Void> deleteRole(String contextId,
 String roleId,
 RequestOptions requestOptions)

Deletes a role. A role that is still referenced by one or more access profiles cannot be deleted: the request is rejected with 409. Reassign or delete those profiles first, then retry. Requires the profiles:d scope.

deleteRole

public VectrosApiHttpResponse<Void> deleteRole(String contextId,
 String roleId,
 DeleteRoleRequest request)

Deletes a role. A role that is still referenced by one or more access profiles cannot be deleted: the request is rejected with 409. Reassign or delete those profiles first, then retry. Requires the profiles:d scope.

deleteRole

public VectrosApiHttpResponse<Void> deleteRole(String contextId,
 String roleId,
 DeleteRoleRequest request,
 RequestOptions requestOptions)

Deletes a role. A role that is still referenced by one or more access profiles cannot be deleted: the request is rejected with 409. Reassign or delete those profiles first, then retry. Requires the profiles:d scope.

getAccessProfileVersions

public VectrosApiHttpResponse<ModelDataVersionPage> getAccessProfileVersions(String contextId,
 String principalId)

Returns the audit trail of changes (create, update, and delete events) for an access profile, most recent first. Version history is always recorded for every access profile; there is no setting to turn it off. Results are paginated. Requires the profiles:r scope.

getAccessProfileVersions

public VectrosApiHttpResponse<ModelDataVersionPage> getAccessProfileVersions(String contextId,
 String principalId,
 RequestOptions requestOptions)

Returns the audit trail of changes (create, update, and delete events) for an access profile, most recent first. Version history is always recorded for every access profile; there is no setting to turn it off. Results are paginated. Requires the profiles:r scope.

getAccessProfileVersions

public VectrosApiHttpResponse<ModelDataVersionPage> getAccessProfileVersions(String contextId,
 String principalId,
 GetAccessProfileVersionsRequest request)

Returns the audit trail of changes (create, update, and delete events) for an access profile, most recent first. Version history is always recorded for every access profile; there is no setting to turn it off. Results are paginated. Requires the profiles:r scope.

getAccessProfileVersions

public VectrosApiHttpResponse<ModelDataVersionPage> getAccessProfileVersions(String contextId,
 String principalId,
 GetAccessProfileVersionsRequest request,
 RequestOptions requestOptions)

Returns the audit trail of changes (create, update, and delete events) for an access profile, most recent first. Version history is always recorded for every access profile; there is no setting to turn it off. Results are paginated. Requires the profiles:r scope.

getRoleVersions

public VectrosApiHttpResponse<ModelDataVersionPage> getRoleVersions(String contextId,
 String roleId)

Returns the audit trail of changes (create, update, and delete events) for a role, newest first. Version history is always recorded for every role; there is no setting to turn it off. Results are paginated. Requires the profiles:r scope.

getRoleVersions

public VectrosApiHttpResponse<ModelDataVersionPage> getRoleVersions(String contextId,
 String roleId,
 RequestOptions requestOptions)

Returns the audit trail of changes (create, update, and delete events) for a role, newest first. Version history is always recorded for every role; there is no setting to turn it off. Results are paginated. Requires the profiles:r scope.

getRoleVersions

public VectrosApiHttpResponse<ModelDataVersionPage> getRoleVersions(String contextId,
 String roleId,
 GetRoleVersionsRequest request)

Returns the audit trail of changes (create, update, and delete events) for a role, newest first. Version history is always recorded for every role; there is no setting to turn it off. Results are paginated. Requires the profiles:r scope.

getRoleVersions

public VectrosApiHttpResponse<ModelDataVersionPage> getRoleVersions(String contextId,
 String roleId,
 GetRoleVersionsRequest request,
 RequestOptions requestOptions)

Returns the audit trail of changes (create, update, and delete events) for a role, newest first. Version history is always recorded for every role; there is no setting to turn it off. Results are paginated. Requires the profiles:r scope.

getUsage

public VectrosApiHttpResponse<UsageReportResponse> getUsage()

Returns full usage detail for the requested calendar month, broken down by category (search, documents, and records) with per-category credit estimates and a split between your live and test environments. Defaults to the current month when year and month are omitted. Requires the billing:r scope on scoped tokens; API keys always have access.

getUsage

public VectrosApiHttpResponse<UsageReportResponse> getUsage(RequestOptions requestOptions)

Returns full usage detail for the requested calendar month, broken down by category (search, documents, and records) with per-category credit estimates and a split between your live and test environments. Defaults to the current month when year and month are omitted. Requires the billing:r scope on scoped tokens; API keys always have access.

getUsage

public VectrosApiHttpResponse<UsageReportResponse> getUsage(GetUsageRequest request)

Returns full usage detail for the requested calendar month, broken down by category (search, documents, and records) with per-category credit estimates and a split between your live and test environments. Defaults to the current month when year and month are omitted. Requires the billing:r scope on scoped tokens; API keys always have access.

getUsage

public VectrosApiHttpResponse<UsageReportResponse> getUsage(GetUsageRequest request,
 RequestOptions requestOptions)

Returns full usage detail for the requested calendar month, broken down by category (search, documents, and records) with per-category credit estimates and a split between your live and test environments. Defaults to the current month when year and month are omitted. Requires the billing:r scope on scoped tokens; API keys always have access.

ping

public VectrosApiHttpResponse<PingResponse> ping()

Returns the identity bound to your credential — your account, principal type, key id, and scope details — so you can confirm who you are authenticated as and that the credential is valid. MCP clients use this to render "signed in as ..." in a chat UI without a separate identity endpoint.

ping

public VectrosApiHttpResponse<PingResponse> ping(RequestOptions requestOptions)

Returns the identity bound to your credential — your account, principal type, key id, and scope details — so you can confirm who you are authenticated as and that the credential is valid. MCP clients use this to render "signed in as ..." in a chat UI without a separate identity endpoint.

listProfilesForPrincipal

public VectrosApiHttpResponse<AccessProfilePage> listProfilesForPrincipal(String principalId)

Returns the access profiles for the given principal across all of your contexts. Use this to answer questions like "which apps does this user have access to?" — for example, to build a member-access summary. Results are confined to your account. Requires the profiles:r scope.

listProfilesForPrincipal

public VectrosApiHttpResponse<AccessProfilePage> listProfilesForPrincipal(String principalId,
 RequestOptions requestOptions)

Returns the access profiles for the given principal across all of your contexts. Use this to answer questions like "which apps does this user have access to?" — for example, to build a member-access summary. Results are confined to your account. Requires the profiles:r scope.

listProfilesForPrincipal

public VectrosApiHttpResponse<AccessProfilePage> listProfilesForPrincipal(String principalId,
 ListProfilesForPrincipalRequest request)

Returns the access profiles for the given principal across all of your contexts. Use this to answer questions like "which apps does this user have access to?" — for example, to build a member-access summary. Results are confined to your account. Requires the profiles:r scope.

listProfilesForPrincipal

public VectrosApiHttpResponse<AccessProfilePage> listProfilesForPrincipal(String principalId,
 ListProfilesForPrincipalRequest request,
 RequestOptions requestOptions)

Returns the access profiles for the given principal across all of your contexts. Use this to answer questions like "which apps does this user have access to?" — for example, to build a member-access summary. Results are confined to your account. Requires the profiles:r scope.

mintToken

public VectrosApiHttpResponse<MintTokenResponse> mintToken(TokenRequest request)

Creates a short-lived JWT bearer token restricted to specific actions and, optionally, to a particular user or identity entity (in any namespace). Use this to hand a narrowly-scoped credential to a browser or downstream service so it never sees your root API key. Only callable with a root API key (sk_*).

mintToken

public VectrosApiHttpResponse<MintTokenResponse> mintToken(TokenRequest request,
 RequestOptions requestOptions)

Creates a short-lived JWT bearer token restricted to specific actions and, optionally, to a particular user or identity entity (in any namespace). Use this to hand a narrowly-scoped credential to a browser or downstream service so it never sees your root API key. Only callable with a root API key (sk_*).

createInvite

public VectrosApiHttpResponse<CreateInviteResponse> createInvite(CreateInviteRequest request)

Invite a new member to one of your app contexts by email. Creates a pending user with a pre-resolved access profile (their permissions on accept) and signs an invitation token. This call is idempotent on the combination of context and email: re-inviting the same email in the same context rotates the token and resends the invitation rather than creating a duplicate. Returns HTTP 201 on a new invite or a successful resend. Returns 409 if that email already belongs to an active or suspended member of the app context, or already has an identity elsewhere in your account (an email can currently belong to only one tenant per account, i.e. your test and live environments cannot share an email). When sendEmail is false, the response includes the raw token and a ready-to-use accept link so you can deliver the invitation through your own email provider. Requires the admin:users scope.

createInvite

public VectrosApiHttpResponse<CreateInviteResponse> createInvite(CreateInviteRequest request,
 RequestOptions requestOptions)

Invite a new member to one of your app contexts by email. Creates a pending user with a pre-resolved access profile (their permissions on accept) and signs an invitation token. This call is idempotent on the combination of context and email: re-inviting the same email in the same context rotates the token and resends the invitation rather than creating a duplicate. Returns HTTP 201 on a new invite or a successful resend. Returns 409 if that email already belongs to an active or suspended member of the app context, or already has an identity elsewhere in your account (an email can currently belong to only one tenant per account, i.e. your test and live environments cannot share an email). When sendEmail is false, the response includes the raw token and a ready-to-use accept link so you can deliver the invitation through your own email provider. Requires the admin:users scope.

resendInvite

public VectrosApiHttpResponse<CreateInviteResponse> resendInvite(CreateInviteRequest request)

Resend an outstanding invitation, identified by its email and app context. Rotates the invitation token and extends its expiry, then (when sendEmail is true) re-delivers the email. Rotating the token invalidates any previously issued link for this invitation, so only the newest link works. The invitee's pending permissions are left unchanged. Requires the admin:users scope.

resendInvite

public VectrosApiHttpResponse<CreateInviteResponse> resendInvite(CreateInviteRequest request,
 RequestOptions requestOptions)

Resend an outstanding invitation, identified by its email and app context. Rotates the invitation token and extends its expiry, then (when sendEmail is true) re-delivers the email. Rotating the token invalidates any previously issued link for this invitation, so only the newest link works. The invitee's pending permissions are left unchanged. Requires the admin:users scope.