Capability library / Application package

Genesys package v1.0.0

Read Genesys users, active user conversations, queues, and conversation analytics; join or unjoin existing queue members, place outbound calls, and delete users. Uses the customer's regional API; conversation reads and calls need a separate user-context token.

Review state: Reviewed · Distributable: yes, digest matches the release manifest

This page describes AAES Govern’s controls. AAES Operate has private-work permissions, operational reviews and recorded-spend limits; it does not include Govern. About AAES Govern

Before you enable this package

The token-revocation cut-off for client-credentials tokens is unestablished in vendor documentation. Treat issued tokens as valid until expiry and verify revocation before enabling. The endpoint host 'genesys-cloud.invalid' is a reserved .invalid placeholder that fails closed until you substitute the real host in both the endpoint URLs and the egress allowlist.

Read each action's effects and exclusions below. Before installation, also read the complete package requirements, including credential issuance, scope, expiry, and provider permissions. These are deployment prerequisites, not capabilities this package supplies.

Capabilities (7)

Each capability below is one registered operation. The complete package JSON includes its exact network destination allowlist. The repository stores it at packs/genesys.json and embeds a copy in the release binary.

Risk tiers. R0 is the minimum for reads. R2 is the minimum for write, create, update, execute, and invoke. R3 is the minimum for delete, send, pay, deploy, approve, share, and transfer. Operators can raise these levels. A minimum tier does not measure the operation's business or confidentiality risk.

On supported execution paths routed through AAES Govern, the R3 actions listed below require approval by an authorized person. Bypass paths and observation-only registrations are outside that guarantee. A provider's restoration feature does not remove this approval requirement. A provider-side approval, such as approving a GitLab merge request, is also separate from AAES Govern human approval. The capability matrix shows which execution paths are implemented, restricted to lab use, or refused at startup. Live compatibility must be tested in your environment.

Field guide. Endpoint is the service address and request method. Connector is the adapter that makes the call. Custody describes how the credential is held; the credential reference identifies the value to resolve. Data class sets handling requirements: pii means personal data, financial means financial records, and internal means internal organizational data.

genesys.users.read v1.0.0R0

Kind
tool
Action
read
Endpoint
GET https://genesys-cloud.invalid/api/v2/users
Connector
http
Custody
customer_vault
Credential ref
secret-ref-genesys-client-credentials-token
Data class
pii

Read users.

List the org's users from the collection endpoint: directory profiles with names and contact details, which are personal data. The registered path covers the collection read only — single-user reads (GET /api/v2/users/{userId}) are not registered by this pack.

The host is a reserved placeholder: substitute the customer's regional API host before enabling.

genesys.conversations.read v1.0.0R0

Kind
tool
Action
read
Endpoint
GET https://genesys-cloud.invalid/api/v2/conversations
Connector
http
Custody
customer_vault
Credential ref
secret-ref-genesys-user-context-token
Data class
pii

Read conversations.

List the authenticated user's active conversations, not all conversations in the organization. This requires the separate user-context OAuth reference in the credential note; adding roles to the pack's client-credentials token does not provide user context. Conversation records include customer identifiers, addresses, and participants and are classified as pii (personal data).

Single-conversation reads (GET /api/v2/conversations/{conversationId}) are not registered. Replace the reserved host with the customer's regional API host before enabling.

genesys.queues.read v1.0.0R0

Kind
tool
Action
read
Endpoint
GET https://genesys-cloud.invalid/api/v2/routing/queues
Connector
http
Custody
customer_vault
Credential ref
secret-ref-genesys-client-credentials-token
Data class
internal

Read queues.

List routing queues from the collection endpoint: queue names and configuration, which reveal contact-center structure and are classified as internal data. The registered path covers the collection read only.

The host is a reserved placeholder: substitute the customer's regional API host before enabling.

genesys.analytics.conversations.query v1.0.0R0

Kind
tool
Action
read
Endpoint
POST https://genesys-cloud.invalid/api/v2/analytics/conversations/details/query
Connector
http
Custody
customer_vault
Credential ref
secret-ref-genesys-client-credentials-token
Data class
pii

Query conversation analytics.

Run a conversation-details analytics query. The vendor method is POST because the query is supplied as a request body, but the operation returns analytics data and mutates nothing, so the governed effect is registered as read.

The request body is unrestricted — the caller chooses filters, interval and metrics — and conversation detail records contain customer and agent data, so the capability registers at the pii class.

The host is a reserved placeholder: substitute the customer's regional API host before enabling.

genesys.queues.members.update v1.0.0R2

Kind
tool
Action
update
Endpoint
PATCH https://genesys-cloud.invalid/api/v2/routing/queues/QUEUE_ID/members
Connector
http
Custody
customer_vault
Credential ref
secret-ref-genesys-client-credentials-token
Data class
pii

Join or unjoin existing queue members.

Join or unjoin up to 100 existing members of one queue. This changes whether members are joined to the queue; it does not add or remove membership. Genesys disregards user-queue pairs that are not already members and processes the update asynchronously, so the response may not show the final state.

The request may carry any member updates allowed by the OAuth client's roles; this registration does not limit the member list. Named users make this pii (personal data). Bind QUEUE_ID and replace the reserved host before enabling.

genesys.conversations.calls.create v1.0.0R3

Kind
tool
Actions
create, send
Endpoint
POST https://genesys-cloud.invalid/api/v2/conversations/calls
Connector
http
Custody
customer_vault
Credential ref
secret-ref-genesys-user-context-token
Data class
pii

Place an outbound call as the authenticated user.

Place an outbound voice call as the authenticated user: according to the reviewed vendor-generated SDK documentation, POST /api/v2/conversations/calls creates a call conversation in user context, so this capability overrides the pack-level client-credentials reference with the separately documented user-context OAuth reference described in the credential note, and the user must meet the platform's station and session prerequisites for placing calls. The effect rings a telephone number and opens a live voice interaction with an end recipient, and the recipient may receive the call before any cancellation.

The capability is therefore registered as create and send at the minimum R3 tier — send is one of the designated actions requiring human approval.

On supported execution paths mediated by AAES Govern, irreversible actions require approval by an authorized person; this does not prevent calls through bypass or observation-only paths.

The request body is unrestricted: the caller supplies the destination number, so the vendor action being 'create' does not lower the effect. The dialed number is personal data.

The host is a reserved placeholder: substitute the customer's regional API host before enabling.

genesys.users.delete v1.0.0R3

Kind
tool
Action
delete
Endpoint
DELETE https://genesys-cloud.invalid/api/v2/users/USER_ID
Connector
http
Custody
customer_vault
Credential ref
secret-ref-genesys-client-credentials-token
Data class
pii

Delete users.

Delete a user from the org. Delete is one of the designated actions requiring human approval; Genesys documents that deleting a user deactivates the account so the person can no longer log in and removes every permission assigned to them. The user's email address, performance data, conversation and chat history, files stored in Documents and voicemails are retained, and are removable only through the GDPR API. A deleted user can be restored to active status, but roles, permissions, extensions and default stations are not reassigned, and a user who was in a custom division comes back in the Home division; a user deleted through the GDPR API cannot be restored. This pack therefore makes no reversibility claim. USER_ID is a placeholder the deployment binds to a concrete user before enabling, and the host is a reserved placeholder to substitute before enabling.

Credential reference

The credential field names a reference rather than containing credential material. Packs are designed not to contain secrets; the format checks cover only known credential formats and cannot prove that arbitrary text contains no secrets. Installing a package registers its capabilities. Configure the provider credentials, endpoints, and network access, then test the integration in your environment before enabling it.

Reference
secret-ref-genesys-client-credentials-token
Custody
customer_vault
Injection
header (Authorization)

Configure the value and injection format specified in the package. Assign responsibility for credential rotation and revocation, restrict provider permissions, and keep credential material out of logs and responses.

Complete credential requirements

Store a complete 'Bearer <access_token>' header value in the client's secret manager. For the pack-level reference, an administrator creates a Client Credentials OAuth client under Admin > Integrations > OAuth and assigns minimal roles and divisions. An external process exchanges its ID and secret at the customer's regional login host, then stores and renews the token. The executor injects the value unchanged; AuthorizeClientCredentials is a Genesys SDK helper for that external process, not the executor.

Read the client's actual token duration. The documented range is 300–172,800 seconds (maximum two days, default 86,400). A client holding only the SCIM Integration role can extend it to 38,880,000 seconds (450 days). HIPAA-enabled organizations impose a 15-minute idle timeout on OAuth-client tokens. Refresh before expiry; an expired value fails closed.

Disabling or deleting the OAuth client stops new issuance, but the reviewed material does not establish immediate invalidation of existing tokens. The client-management documentation says clients under 30 days are deleted irreversibly, older clients deactivate for seven days, and applications using deleted credentials lose access. It does not establish the residual validity window for issued tokens. Treat them as valid until expiry unless the deployment verifies cut-off with Genesys; review that behavior before enabling.

Two capabilities need a separate reference, secret-ref-genesys-user-context-token: genesys.conversations.read and genesys.conversations.calls.create. These operations act in user context; more roles on a Client Credentials token do not supply it.

That reference stores the complete 'Bearer <access_token>' header minted externally through a user-context OAuth grant, such as authorization code or implicit, at the regional login host for a dedicated user. The external process owns the grant and refresh. Calls additionally require an assigned, provisioned station and an active user session; verify those platform prerequisites before enabling.

Keep each token only in executor memory for a call, never in logs, traces, diagnostics, or crash dumps. Do not enable the pack if the deployment cannot meet those requirements.

Resources

  • genesys-org-users (api, pii): https://genesys-cloud.invalid/api/v2/users
  • genesys-org-conversations (api, pii): https://genesys-cloud.invalid/api/v2/conversations
  • genesys-org-routing (api, internal): https://genesys-cloud.invalid/api/v2/routing/queues

Technical package and review record

Complete provider requirements and exclusions

Review status: on 2026-09-23, every registered endpoint, method, operation ID, summary, and OAuth scope was checked against Genesys's first-party swagger reference. The API host's /api/v2/docs/swagger route redirects to Genesys's publicapi-v2-latest.json schema on its own public S3 host, the source used by the Developer Center's API explorer.

The pack was initially based on official SDK repositories because the JavaScript-only Developer Center reference could not be extracted, and the /api/v2/docs/swagger.json route returned 404. The later first-party schema review resolved that reference-access gap.

Deployment obligations, not review gaps: the owners are placeholders the deployment replaces with accountable humans, the reserved host below must be substituted before enabling, and the unverified token-revocation cut-off named in the credential note is a deployment-time verification item this pack claims nothing about.

The endpoint host 'genesys-cloud.invalid' is a reserved non-production placeholder (an RFC 2606 reserved TLD): Genesys Cloud hosts are region-specific (the official SDK documents base paths such as https://api.mypurecloud.com, https://api.mypurecloud.jp and per-region login hosts for token issuance), so substitute the customer's regional API host before enabling, in every endpoint, in the resource locators and in every egress allowlist entry — the allowlist matches exactly, so all three must be substituted together, and substitution is a required deployment step.

External token issuance: an external deployment process exchanges the OAuth client's client id and client secret at the region's login host for an access token and stores and renews the complete header value described in the credential note; storing the client credentials themselves under the reference does not make the HTTP injector perform OAuth — the injector injects the stored value verbatim.

Approval classification: conversations.calls.create places a live outbound voice call to an end recipient — a message delivered to a person — so it is registered as create and send at the minimum R3 tier; send is one of the designated actions requiring human approval. The analytics capability registers as read even though the vendor method is POST: the Genesys analytics query endpoints accept a query body and return data without mutating state, so the governed effect is a read.

Documented exclusions — this pack does not register: authorization administration (creating roles or divisions, assigning roles to users — privilege-granting mutations of the access-control plane itself); OAuth client management (creating or deleting the very clients that mint tokens); Architect flow publishing and check-in (a deploy of routing logic to production); conversation recording deletions and recording-policy changes (erasure of compliance records); telephony and trunk configuration; organization and WFM administration; external-contacts bulk import and bulk delete; and the notification/WebSocket channels — each is a different registration requiring its own review, and none is approximated here.

Download the complete package JSON for exact network allowlists, credential requirements, exclusions, and setup notes. Read these requirements before installation.

The full documentation review record is supplied in the evaluation package. The evaluation package runs in your environment and comes only with the paid design partnership. This page reproduces the source links and review block; the full record is available for evaluation. Discuss a design partnership to inspect it before installation.

Review block

This section reproduces the review block recorded in the pack file. The evidence and approval record is separate: for a reviewed pack, it is in the evaluation materials and in the release binary's embedded assets.

Review completed: 2026-10-22

10 sources, retrieved 2026-09-21, 2026-09-23, 2026-10-22

Current documentation links are navigation aids. They do not change the package, its historical sources or its review date. Review dates describe a documentation review, not a live integration test. No package is provider-endorsed or yet tested against a live provider tenant.

Release identity

SHA-256 of the pack file bytes: d5d4122bd2270c794c2251ef0ea80504358afa284d4aa1380d7cb90e269d3bdb

Distributable: yes, digest matches the release manifest. Editing a package changes its release identity. A deployment plan checks its own file digests; it does not restore reviewed status or authenticate approval.