GuidesAPI Reference
API Reference

/support

Register support access for an authorized user or users to enable AccountExecutive logins to the calling principal's realm. The registered authorized user(s) will be allowed to login as Account Executives to the realm.

  • If the registered authorized user's emailAddress is not the wildcard value '*', an email notification will be sent indicating that the user has been invited as an AccountExecutive to the realm.
  • If the registered authorized user's emailAddress is the wildcard value '*', no email notification will be sent


NOTE: A maximum of 5 individual email addresses and/or a single wildcard entry '*' may be registered for AccountExecutive access. This API is idempotent and may be called repeatedly with the same request parameters. If an already registered email address is provided, a duplicate email notification will be sent.


NOTE: This API will return 404 if Account Executive support access is not enabled for the realm.


Access Control:

  • The calling principal must have "manageAccountExecutives" permission in the "account" service.
  • This API is rate limited to a maximum of 6 calls per minute per realm
  • The calling principal MUST NOT include a project scope.
Body Params
string
required

Email address of user being authorized for support access in this realm. Must end in @here.com or equal '*' to represent any @here.com email address.

date-time

Time that this user's access expires. Must be in yyyy-MM-ddTHH:mm:ss(.NNN)Z format. If omitted, this user's access does not expire.

Headers
string

The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services.

string

Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response.

Responses

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json