Access
The following endpoints allow you to view and manage end-user access to the specified merchant/domain as well as instantly provision credentials for end-users to access our portal.
Retrieves all users that have access to the merchant's company
API key generated in Clym Partner Portal.
Either a merchant ID or a domain ID is required
An array with all users
GET /api/portal/instance/access/users HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
An array with all users
{
"meta": {
"current_page": 1,
"next_page": 1,
"prev_page": 1
},
"result": [
{
"id": "c4111c2607214aaaa9349371wkflsagx",
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"role": "OWNER",
"is_active": true,
"created_by": {
"id": "text",
"email": "[email protected]",
"first_name": "text",
"last_name": "text"
}
}
]
}Grant company access to the specified user with the specified role. The system will send an invitation email to the newly created user.
API key generated in Clym Partner Portal.
The role the user will be granted in the company.
OWNERPossible values: Merchant added to the partner account
POST /api/portal/instance/access/users HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"email": "[email protected]",
"role": "OWNER"
}Merchant added to the partner account
{
"result": {
"id": "c4111c2607214aaaa9349371wkflsagx",
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"role": "OWNER",
"is_active": true,
"created_by": {
"id": "text",
"email": "[email protected]",
"first_name": "text",
"last_name": "text"
}
}
}Instantly provision the specified user and role in the company and return a magic link. This performs just-in-time user access creation or access updating.
API key generated in Clym Partner Portal.
Either a merchant ID or a domain ID is required
The email account of the user you want to provision
The role to assign to the specified user
Set this field to false to disable switching between companies for the target user.
trueThe user access information and authentication information
POST /api/portal/instance/access/users/provision HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 62
{
"email": "[email protected]",
"role": "OWNER",
"access_switch": true
}The user access information and authentication information
{
"result": {
"id": "text",
"email": "[email protected]",
"role": "OWNER",
"is_active": true,
"login_url": "https://example.com"
}
}Retrieve information about a user's access
API key generated in Clym Partner Portal.
User id
Either a merchant ID or a domain ID is required
The user access information
GET /api/portal/instance/access/users/{userId} HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
The user access information
{
"result": {
"id": "c4111c2607214aaaa9349371wkflsagx",
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"role": "OWNER",
"is_active": true,
"created_by": {
"id": "text",
"email": "[email protected]",
"first_name": "text",
"last_name": "text"
}
}
}Update access information for the specified user
API key generated in Clym Partner Portal.
User id
Either a merchant ID or a domain ID is required
The new role to assign to the user
Enables or disables the user's access in the company.
Acknowledgement that request was successful.
PUT /api/portal/instance/access/users/{userId} HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"role": "OWNER",
"is_active": true
}Acknowledgement that request was successful.
{}Removes the specified user's access in the company.
API key generated in Clym Partner Portal.
User id
Either a merchant ID or a domain ID is required
User access deletion confirmation
DELETE /api/portal/instance/access/users/{userId} HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
User access deletion confirmation
{
"result": {}
}Last updated