Consumer accounts

The API Consumers list shows every developer with an account in your API Portal. Each row carries an approval status, so you can see at a glance who is approved and who is waiting. Open a consumer to see their profile, subscriptions, teams, and any pending requests.

What is the API Consumers list?

It is the dashboard list of every developer with an account in your API Portal. Open it from Consumers, API Consumers. The search box is labelled Consumers and matches on ID, name, and email.

You narrow the list with these filters:

To invite a developer yourself, use Invite User. It opens Invite a new User to this portal and sends a sign-up request by email with Send Request. You see the consumer's details only after they register. Inviting needs the Organisation Owner, or the Organisation Admin or Portal Admin role; see Members and roles.

What are the consumer approval statuses?

The Approval column reads Approved, Pending, or Canceled. Approved consumers can use the portal. Pending consumers are waiting for registration approval. Canceled means the registration was rejected.

Consumers wait for approval only when you set a registration approval group under Settings, Portal settings, Portal details, in Registration process approval. Without one, new accounts are approved at once. See Registration and details.

If you are a member of the registration approval group, a pending row shows a 1 pending link that opens the consumer's Requests tab. Everyone else sees a plain Pending label.

What can you see on a consumer?

Open a consumer to reach their detail page. The header shows the consumer's name and approval state. The Details, Subscriptions and Teams tabs are always there, and a Requests tab appears while the consumer has pending items.

What is on the Details tab?

The Details tab lists the consumer's profile fields. Auth Type reads Federated SSO when the consumer signed in through an identity provider, or Password when they use a portal password.

When custom registration properties are turned on for your portal, a Custom properties table lists each property and the consumer's value.

When a payment provider is connected, an Advanced section shows the consumer's payment provider customer ID and the matching customer entries found in your payment provider.

How do you approve or remove a consumer?

A member of the registration approval group sees Reject and Approve in a pending consumer's header, each with a confirmation. Approving makes the account active. Rejecting marks it Canceled. The same registration also waits in the Requests inbox.

To remove a consumer, use Delete User in the Danger Zone of the Details tab. It needs the Organisation Owner, or the Organisation Admin or Portal Admin role.

Delete User stays disabled while the consumer owns a subscription that is Active, Pending Approval, Pending Payment, or Payment Failed. Cancel those subscriptions or move their ownership to another team member first. Deleting a consumer leaves their teams, subscriptions and credentials in place, so regenerate any credentials the consumer had access to.

Troubleshooting

Where to next