Skip to main content

OrbisID

Connector maturity: GA. See Connector maturity.

Description​

The OrbisID connector lets one OrbisID instance scan another OrbisID instance's own application users. Organisations that run multiple OrbisID deployments (e.g. one per region, business unit, or environment) can use this connector to centrally track which application accounts hold the ADMINISTRATOR role across every instance they own — the same way any other target system's privileged accounts are tracked. Authentication uses an SDK API key created on the target instance (Administration > Access & Security > API Keys); no OrbisID SDK installation or extra software is required.

System Type Classification​

FieldValue
System TypeApplication
Default Scan Priority500

Version Support​

OrbisID EditionSupported
CommunityNo
ProYes
EnterpriseYes

OrbisID-to-OrbisID scanning requires a Pro or Enterprise licence.

Supported Protocol​

ProtocolPortNotes
OrbisID REST API (HTTPS + SDK API key)443 TCP (default)X-API-Key header authentication. Any port can be used — see Port below

What OrbisID Discovers​

DataSource
Application user accountsGET {baseUrl}/api/v1/sdk/users
User attributes: display name and emailfullName and email fields, shown as the account's displayName and email attributes
Account status (enabled/disabled)enabled field, derived from the target user's status and lock state
Application rolerole field — the user's effective role (resolves an OIDC-inherited role to its mapped value)

Privileged Role Detection​

Each distinct role returned is discovered as its own Entitlement (type ORBISID_ROLE). Only ADMINISTRATOR is flagged privileged, matching that role's full-access scope in OrbisID's own RBAC model — IAM_GOVERNANCE_MANAGER and IAM_GOVERNANCE_ANALYST are discovered as non-privileged entitlements.

Connection Requirements​

SDK API Key on the Target Instance​

  1. On the target OrbisID instance (the one being scanned), sign in as an Administrator
  2. Navigate to Administration > Access & Security > API Keys
  3. Click Create API Key, give it a descriptive name (e.g. scan-from-eu-prod), and copy the key immediately — it is shown only once
  4. No additional role or scope configuration is needed; the key only grants access to the read-only /api/v1/sdk/* endpoints

Credential Mapping​

OrbisID FieldValue
credential.passwordThe SDK API key created on the target instance
credential.usernameNot used — leave blank or use a reference label

System Attributes​

None required. Optional:

AttributeDefaultPurpose
Discover API KeysOffAlso discover the target instance's own SDK API keys as Non-Human (API Key) accounts
Trust All TLS CertificatesOffAccept the target instance's certificate without validating its chain — for a test or internal instance using a self-signed certificate. The host name must still match the certificate

Network Requirements​

RequirementDetail
Outbound HTTPSThe scanning OrbisID instance (or its On-Premise Agent) must reach the target instance's hostname on the configured port (443 unless set otherwise)

Configuration Steps​

  1. Create an SDK API key on the target instance (see above)
  2. Create a Credential in OrbisID:
    • Username: (optional, e.g. eu-prod-scan-key for reference)
    • Password: The SDK API key value
  3. Navigate to Systems → Add System
  4. Fill in the fields:
FieldValue
System Name (General tab)Descriptive name (e.g., OrbisID – EU Prod) — an identifier only, not used to connect
IP Address / Hostname (Connection tab)Base URL of the target instance (e.g., https://orbisid-eu.example.com). https:// is assumed if no scheme is given
Port (Connection tab)Optional. Used when the address above has no port of its own (e.g., 8443). A port written in the address takes precedence
OS TypeOrbisID
System TypeApplication
CredentialThe SDK API key credential created above
  1. Click Test Connection — this calls the target instance's /api/v1/sdk/validate-key endpoint
  2. Click Save
Scanning an OrbisID Windows Installer Instance

A default Windows install serves the web UI at https://<host>:8443 with a self-signed certificate. Either set the address to https://<host>:8443 and tick Trust All TLS Certificates, or — when scanning an instance on the same machine — use http://localhost:8080, which reaches its backend directly.

One System Per Instance

Add one Target System per OrbisID instance you want to track, each with its own dedicated API key credential — this mirrors how every other connector in OrbisID is configured.

Troubleshooting​

SymptomLikely CauseResolution
"… the SDK API key was rejected (401)" / "Invalid or expired API key"Wrong or revoked API keyRe-create the API key on the target instance and update the credential
401 / "This API key is not authorised for SDK operations"A non-SDK API key was used (e.g. a Scan Agent or Endpoint Sensor key)Create a dedicated key of type SDK via Administration > Access & Security > API Keys
"Could not connect to … - nothing is accepting connections there"Wrong port, or the instance is not runningSet the Port field or include the port in the address (e.g. https://host:8443)
"The TLS certificate presented by … is not trusted"The target uses a self-signed or privately issued certificateInstall a trusted certificate on the target, or tick Trust All TLS Certificates for a test or internal instance
"… got no HTTP response - that port probably expects HTTPS"An http:// address was used for an HTTPS portChange the address to https://
"Could not resolve the host in …"Host name typo or DNS not reachableCheck the IP Address / Hostname field
"Timed out connecting to …"Network path to the target instance blockedConfirm outbound access to the target instance on the configured port; use an On-Premise Agent if the target is on a segmented network
No accounts returnedTarget instance has no users, or the wrong field has the base URLVerify the base URL is set in IP Address / Hostname on the Connection tab, not System Name on the General tab — System Name is a display-only identifier and is never used to connect
"OrbisID base URL is required" error even though a value was enteredThe base URL was entered in System Name (General tab) instead of IP Address / Hostname (Connection tab)Move the base URL to the IP Address / Hostname field on the Connection tab