Skip to content
GOCUX
Documentation
GOCUX / Documentationservice api

Guide: provision an authorized client identity

Choose the supported identity path for a programmatic client.

Choose the supported identity path for a programmatic client.

Practical procedure

  1. Identify whether the client is a human-operated CLI or a service integration. Use its actual supported authentication flow.
  2. Have the authorized deployment or account workflow provision the required identity; keep the credential out of source code and documentation.
  3. Read /me with the configured client to verify company and identity context before attempting any data or paid operation.

Separate the external system from GoCux authority

A named external tool in a workflow does not establish a native GoCux integration. Start with an authorized export, an already configured connector, or a separately implemented adapter. Keep external account credentials in the owning system. In GoCux, inspect the available connector and its grants; the fact that a connector is registered does not itself authorize a task to use it.

Contract example

Developer examples below describe routes on an authorized, configured GoCux control-plane base URL. They are request shapes or operation references, not claims that a particular public hostname exposes the API. Use the workspace for the corresponding human workflow; availability and permissions depend on the actual deployment.

Operation reference for this workflow

GET /me
GET /v1/models

Inspect the result

The useful outcome is an explicit boundary: what information enters GoCux, which task can access it, and what result leaves. Start with a read-only sample and verify its source context. A local client or adapter owns the external invocation and its error handling unless an actual deployed connector provides that behavior.

What to keep explicit

A service identity is not a signed-in human. This page does not invent customer API-key creation or promise a self-service key dashboard.

Handle incomplete and refused work

Authentication with the external system is separate from GoCux authentication. Missing grants, revoked permissions or unavailable connectors must remain visible; do not replace them with invented data. Publishing a marketplace listing, creating a paid external resource or sending messages is a separate action from preparing an integration guide.

Bring this workflow into your workspace.

Set the scope. Review the evidence. Approve the steps that need it.

Open the workspace

Keep exploring