Docs/Admin API/Users/Create portal session

Create portal session

POST/admin/v1/users/{userId}:createPortalSession

Create Portal session.

path parameters

userId
string
Required
The user ID.
In addition to supporting the UserHub user ID, you can also pass in the User Provider external identifier in the format <externalId>@<connectionId> and if the user doesn't exist in UserHub they will automatically be imported.

body parameters

portalUrl
string
The Portal URL, this is the target URL on the portal site.
If not defined the root URL for the portal will be used.
This does not need to be the full URL, you have the option of passing in a path instead (e.g. /).
You also have the option of including the {accountId} string in the path/URL which will be replaced with either the UserHub user ID (if organizationId is not specified) or the UserHub organization ID (if specified).
Examples:
- /{accountId} - the billing dashboard
- /{accountId}/checkout - start a checkout
- /{accountId}/checkout/<some-plan-id> - start a checkout with a specified plan
- /{accountId}/cancel - cancel current plan
- /{accountId}/members - manage organization members
- /{accountId}/invite - invite a user to an organization
returnUrl
string
The URL the user should be sent to when they want to return to the app (e.g. cancel checkout).
If not defined the app URL will be used.
successUrl
string
The URL the user should be sent after they successfully complete an action (e.g. checkout).
If not defined the return URL will be used.
organizationId
string
The organization ID.
When specified the {accountId} in the portalUrl will be replaced with the organization ID, otherwise the user ID will be used.

Returns

redirectUrl
string
The URL you should redirect the user to after calling create portal session.

code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
localeMessage
string
A user-facing error message.

curl https://api.userhub.com/admin/v1/users/auth0%7C123456789@conn_26yEiYymqy6ZmG:createPortalSession \
  -H "Authorization: Bearer $USERHUB_ADMIN_KEY" \
  -X POST

const res = await adminApi.users.createPortalSession(
  "auth0|123456789@conn_26yEiYymqy6ZmG",
);

res, err := adminApi.Users().CreatePortalSession(
    context.Background(),
    "auth0|123456789@conn_26yEiYymqy6ZmG",
    nil,
)

$res = $adminApi->users->createPortalSession(
    userId: 'auth0|123456789@conn_26yEiYymqy6ZmG',
);

res = admin_api.users.create_portal_session(
    user_id="auth0|123456789@conn_26yEiYymqy6ZmG",
)

Response bodyJSON

{
  "redirectUrl": "https://billing.example.com/signin?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

PreviousCreate API session

NextUser API

Create portal session

.css-10iahqc{text-transform:capitalize;}path parameters

body parameters

Returns

path parameters