API Reference
Log In
API Reference

Create a Credential

post
https://api.revenium.ai/profitstream/v2/api/credentials

Creates a credential. A credential links an ID your customer sends with their usage (externalId) to a subscriber and a customer organization, so that usage is attributed to them. The name must be unique within the customer organization.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Credential configuration. Requires teamId, organizationId, subscriberId, and externalId together.

A credential links an ID your customer sends with their usage (externalId) to a subscriber and a customer organization, so that usage is attributed to them.

string
required

The credential's name. Must be unique within the customer organization.

team
string | null
required

The ID of the team that owns this credential. It cannot be changed after the credential is created.

organization
string | null
required

The ID of the customer organization whose usage this credential is attributed to

subscriber
string | null
required

The ID of the subscriber whose usage this credential is attributed to

string
required

The ID your customer sends with their usage data (as subscriberCredential), for example their API key ID. Usage carrying this value is attributed to this credential's subscriber and organization. Responses show it masked, as three dots and its last four characters, for example ...9c2e.

string | null

An optional secret stored with the credential, for example one issued by your identity provider. On update, an empty value keeps the current secret.

subscriptionIds
array of strings | null

The IDs of the subscriptions to link to this credential. On update, a list replaces the linked subscriptions, an empty list unlinks them all, and leaving it out or sending null keeps them.

subscriptionIds
tags
array of strings | null

Tags for this credential. On update, a non-empty list replaces the tags and an empty or missing list keeps them.

tags
string | null

Not used by this API. It is ignored on create and update, and responses always return null.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/hal+json
*/*

Updated 5 months ago

Did this page help you?