Consumers
Consumer accounts
The API Consumers list shows every developer who has signed in to your API Portal, with their approval status. Open a consumer to see their details, subscriptions, teams, and requests.
The API Consumers list shows every developer who has signed in to your API Portal. Each row carries an approval status, so you can see at a glance who is active 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. The list opens from API Consumers under the Consumers group. The search box is labelled Consumers and matches on ID, name, and email.
You filter the list by:
| Filter | What it narrows to |
|---|---|
| Status | Approval status: Active, Pending, or Rejected. |
| Teams | Only internal teams, only external teams, or both. |
| Company | A specific company. Shown only when the company feature is enabled. |
| Identity Provider | The identity provider the consumer signed in through. |
To invite a developer yourself, use Invite User. It sends an email invitation and is available when your role allows managing portal users.
What are the consumer approval statuses?
A consumer is Approved, Pending, or Canceled. Approved consumers can use the portal. Pending consumers are waiting on a decision. Canceled consumers were rejected. These map to the ACTIVE, PENDING, and REJECTED states in the code.
| Status shown | State | What it means |
|---|---|---|
| Approved | ACTIVE | The consumer can sign in and subscribe. |
| Pending | PENDING | The consumer is waiting on approval. |
| Canceled | REJECTED | The account was rejected. |
On the list, a pending row links straight to that consumer's Requests tab, where the approve and reject controls live alongside any pending subscription or scope items.
What can you see on a consumer?
Open a consumer to reach their detail page. It carries the consumer's name and an approval badge in the header, plus tabs for their account, subscriptions, and teams. A Requests tab appears only when the consumer has pending requests.
| Tab | What it shows |
|---|---|
| Details | The consumer's profile: email, name, auth type, identity provider, provider ID, and account created date. |
| Subscriptions | The subscriptions this consumer owns. |
| Teams | The teams this consumer belongs to. |
| Requests | Pending registration, subscription, and scope requests for this consumer. Shown only when there are any. |
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 used a portal password. The Identity Provider field names that provider.
| Field | What it tells you |
|---|---|
| The consumer's email address. | |
| Name | Given and family name, when set. |
| Auth Type | Federated SSO or Password. |
| Identity Provider | The provider the consumer signed in through, when federated. |
| Provider ID | The consumer's identifier at the identity provider. |
| Account Created | The date the account was created. |
When custom registration properties are enabled for your portal, a Custom Properties table lists each property and the consumer's value.
How do you approve or remove a consumer?
If you are in the right approval group, a pending consumer shows Approve and Reject in the header. Approving sets the consumer to Active. Rejecting sets them to Rejected. Approvals also live on the consumer's Requests tab, next to any pending subscription and scope items.
To remove a consumer, use the delete control in the Details tab danger zone. A consumer who owns active subscriptions cannot be deleted, and the button stays blocked until those subscriptions are removed or held by another team member. Deleting a consumer is gated by the role that allows managing portal users.
Where to next
Teams and companies
How consumers group into teams, invite members, and map domains to companies.
Requests and approvals
The single place to approve registration, subscription, and scope requests.
Scope grants
How consumers request Optional and Restricted scopes, and how you approve them.
Developer onboarding
The consumer-side experience: signing in, subscribing, and getting credentials.