Partner Portal

Get partner portal logged in user info

Get the Partner Portal profile of the authenticated caller: name, the responsibilities they hold on their partner account, whether they are a Rhombus Certified Technical Professional, and their organization's reseller tier, partner level, channel account manager and purchasing vehicle. The response also includes whether the caller has been granted Partner Portal access; unlike the other partner portal endpoints, this endpoint answers 200 whenever the caller's Contact can be looked up, returning a null loggedInUser when no Contact matches and the grantPortalAccess flag otherwise, so clients can hide the portal UI. It still denies with 403 when the session has no organization or email, or the Salesforce lookup fails.

POST/api/partnerportal/getLoggedInUserInfo

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: partner-api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

Body

application/json · object

Request object for reading the Partner Portal profile of the authenticated caller. This request carries no fields: the partner organization and the caller's identity are resolved from the authenticated session.

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/partnerportal/getLoggedInUserInfo' \
  --header 'x-auth-scheme: partner-api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api2.rhombussystems.com/api/partnerportal/getLoggedInUserInfo"
headers = {
    "x-auth-scheme": "partner-api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/partnerportal/getLoggedInUserInfo', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'partner-api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {}
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/partnerportal/getLoggedInUserInfo"))
            .header("x-auth-scheme", "partner-api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "error": false,
  "errorCode": "<string>",
  "loggedInUser": {
    "camOwnerName": "<string>",
    "firstName": "<string>",
    "grantPortalAccess": true,
    "id": "<string>",
    "lastName": "<string>",
    "partnerLevel": "<string>",
    "purchasingVehicle": "<string>",
    "resellerTier": "<string>",
    "responsibilities": [
      "<string>"
    ],
    "rhombusCertifiedTechnicalProfessional": true
  }
}

Response

200 OK

application/json · object

Response object containing the Partner Portal profile of the authenticated caller.

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

loggedInUserobject

The Partner Portal profile of the authenticated caller, projected down to the fields a partner may see.

Show child attributes

camOwnerNamestring | null

Name of the Channel Account Manager who owns the caller's partner organization, or null if none is assigned

firstNamestring | null

First name of the caller

grantPortalAccessboolean | null

Whether the caller has been granted Partner Portal access. Every other partner portal endpoint denies with 403 when this is not true; clients should hide the portal UI when it is false or absent.

idstring | null

Salesforce Contact id of the caller

lastNamestring | null

Last name of the caller

partnerLevelstring | null

Partner level of the caller's partner organization

purchasingVehiclestring | null

Purchasing vehicle of the caller's partner organization

resellerTierstring | null

Reseller tier of the caller's partner organization

responsibilitiesstring[] | null

Responsibilities held by the caller on their partner account, as Salesforce multi-select picklist values (for example Account Profile Administrator). Empty, never null, when the caller holds none.

rhombusCertifiedTechnicalProfessionalboolean | null

Whether the caller is a Rhombus Certified Technical Professional, or null if unknown

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND, SELF_PROVISIONING_DISABLED, SKU_NOT_ALLOWED, QUANTITY_INVALID, AUTO_RENEW_REQUIRED, PROVISION_CAP_EXCEEDED, ACKNOWLEDGEMENT_REQUIRED, SIGNATURE_REQUIRED, APEX_VALIDATION, SKU_NOT_IN_PRICEBOOK.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT, NOT_VERIFIED_MSP, ORDER_NOT_YOURS.
429 Too Many Requests. errorCode is one of: RATE_LIMITED, QUOTE_RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE, SALESFORCE_UNAVAILABLE.