Oxelone Docs

Search docs and API

Find a guide, a section of one, or an API operation by its name.

Open console (opens in a new tab)

Connectors OpenAI

OpenAI

The OpenAI connector reads one OpenAI API organisation with its Admin API key: users, invites, projects, API keys, rate limits, retention and permission settings, usage and, if you opt in, costs and the audit log. How the connect flow works is on How connectors work.

Who can do it

Connecting needs connections:manage (Manage connections), held by Owner, Admin and Fleet operator.

Connect

  1. Go to Collection › Connectors and choose Connect on OpenAI. There is one mode, API Platform: "One OpenAI API organisation, read with its Admin API key."
  2. Give the connection a Name.
  3. Paste the Admin API key into the password field. The hint reads "From the OpenAI platform's Settings › Admin keys; a project key is refused."
  4. Continue through Check and Rules, then choose Create connection.

The connector sends the key to OpenAI's Admin API and reads the organisation OpenAI names in its answer. You do not type an organisation.

What it reads

RecordsWhat you get
UsersThe organisation's members and their role.
InvitesPending, accepted and expired invitations.
ProjectsEvery project, archived ones included.
Project membersWho is in each project, and as what.
Project API keysEach project's keys: owner, expiry, last use, and whether the owner still has access.
Service accountsEach project's service accounts and their role.
Admin API keysThe organisation's Admin keys. Read only; Oxelone never creates one.
Project rate limitsPer-model request and token limits on each project.
CertificatesUploaded certificates: active or not, and when they expire. Never the certificate itself.
GroupsGroups, and whether the identity provider manages them.
RolesThe organisation's roles, predefined and custom.
Data retentionThe retention setting of the organisation and of each project.
Model permissionsEach project's allow-list or deny-list of models.
Hosted tool permissionsWhich hosted tools each project may use.
Spend limitsThe hard monthly spend limit of the organisation and of each project.
UsageDaily token and request counts per project and model, one bucket per usage family.
CostsOff by default. "Stores what the organisation spends, per project and line item, every day."
Audit eventsOff by default. "Stores who did what, with their email and the IP address it came from."

What it can do

All need the Organization Admin permission with write access.

ActionConsequenceReversible
Remove from organisationThe person loses access to the organisation; getting back in takes a new invite.No
Demote to readerThe person keeps access and loses the owner role.Yes
Delete inviteThe invitation is withdrawn. "If the invite has already been accepted, it cannot be deleted."No
Archive project"Archived projects cannot be used or updated." "Projects can be created and archived, but cannot be deleted."No
Remove from projectThe person loses access to this project and keeps their organisation membership.Yes
Delete project API keyThe key stops working; its value was only ever shown at creation.No
Delete service accountThe service account and its key stop working; re-creating mints a new key.No
Delete Admin API keyThe Admin key stops working. Oxelone refuses to delete its own key.No

What it checks

Fourteen posture checks, no inspections.

RuleSeverityAction offered
Project API key whose owner lost accessHighDelete project API key
Project API key with no expiryMediumNone
Admin API key with no expiryMediumNone
Project API key unused for 90 daysLowDelete project API key
Organisation ownerLowNone
Service account with the owner roleMediumDelete service account
Web search enabled on a projectLowNone
MCP enabled on a projectMediumNone
Code interpreter enabled on a projectLowNone
File search enabled on a projectLowNone
Certificate expires within 30 daysMediumNone
Group not managed by the identity providerLowNone
Failed sign-inLowNone
SCIM switched offHighNone

The last two read Audit events, so they run only if you switch that record kind on.

What it needs to be Readable

An Admin API key with the Organization Admin permission. A project key is refused. If the key lacks the permission, each row reads "Not readable — the credential lacks the Organization Admin permission."

Sync period

1 h, 6 h and 1 d. There is no 15-minute period.

When it goes wrong

The messages are the shared ones on How connectors work, for example "the vendor refused this credential (code). Check that it has the permissions this connector asks for, and that it has not expired."

With the API

Not available with an API key.