Skip to main content
API7.ai Logo
Version: 3.10.x

Manage Developers

Developers are the users of your Developer Portal. Some developer-management tasks are handled through the Provider Portal Admin API, while developer creation is exposed by the standalone Developer Portal backend.

Prerequisites​

Create a token by following Obtain a Token from the Dashboard and export it:

export API_KEY="a7ee-xxxxxxxxxxxxx"

List Developers​

Retrieve all developers registered on a portal:

curl -k "https://localhost:7443/api/developers?portal_id={portal_id}" \
  -H "X-API-KEY: ${API_KEY}"

If you are not running locally, replace localhost with your Dashboard host. The -k flag is required if the Dashboard uses a self-signed TLS certificate.

The response includes developer metadata:

{
  "list": [
    {
      "id": "d1a2b3c4-...",
      "developer_id": "org_abc123",
      "username": "jane.smith",
      "name": "Jane Smith",
      "email": "jane@example.com",
      "email_verified": true,
      "state": "Active",
      "provider": "builtin",
      "last_active_at": "2025-01-15T10:30:00Z",
      "created_at": "2025-01-10T08:00:00Z"
    }
  ],
  "total": 1
}

Email-and-password registration creates a portal user. Creating an organization then creates an active developer in the control plane. The Provider Portal does not expose a registration-approval setting, and the public APIs do not create developer-registration approval requests.

Create a Developer​

Developer accounts are normally created when someone creates an organization in the Developer Portal (see Register and Log In).

To provision a developer programmatically, call the standalone Developer Portal backend (default :4321), not the Dashboard / Provider Portal Admin API. The relevant endpoint is POST /api/developers; request body, response schema, and authentication headers (Authorization: Bearer a7prt-… plus X-Portal-Developer-ID: <id>) are documented in the Developer Portal API reference.

In the default Developer Portal implementation, organization invitations are typically handled in the Developer Portal experience itself rather than through this endpoint.

Review Custom Registration Approvals​

Use these endpoints only when existing or source-customized workflows have produced developer_registration approval records. The public APIs do not create these records, and they are not part of the email-and-password sign-up flow in the released frontend.

List Pending Approvals​

curl -k "https://localhost:7443/api/approvals?event=developer_registration&status=pending" \
  -H "X-API-KEY: ${API_KEY}"

Approve a Registration​

curl -k -X POST "https://localhost:7443/api/approvals/{approval_id}/accept" \
  -H "X-API-KEY: ${API_KEY}"

On approval, the developer's state changes from Pending to Active.

Reject a Registration​

curl -k -X POST "https://localhost:7443/api/approvals/{approval_id}/reject" \
  -H "X-API-KEY: ${API_KEY}"

On rejection, the developer account is deleted.

Delete a Developer​

Deleting a developer removes the developer account and all associated resources:

curl -k -X DELETE "https://localhost:7443/api/developers/{developer_external_id}?portal_id={portal_id}" \
  -H "X-API-KEY: ${API_KEY}"
caution

Deleting a developer is irreversible and cascades to all resources owned by the developer, including applications, credentials, subscriptions, and pending approval requests.

Developer Identity Providers​

The provider field on a developer record indicates how the account was created:

ProviderDescription
builtinCreated through the released Portal API. This includes organization-backed records whose frontend authentication uses email and password or locally configured OAuth.
ssoCreated by an existing, legacy, or source-customized external identity workflow. The released frontend does not store its locally configured OAuth users with this value.
scimCreated by an existing or source-customized SCIM workflow. The released frontend does not register SCIM by default.

Additional Resources​