API ReferenceEntity Group

Generate JWT Token

Generate a JWT token for an entity group with the given options. This token can be used to authenticate to any entity in the entity group in the Mercoa API and iFrame.

We recommend using this endpoint. This will enable features such as approvals and comments.

Path parameters

entityGroupIdstringRequired

Entity Group ID or Entity Group ForeignID

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
expiresInstringOptional

Expressed in seconds or a string describing a time span. The default is 1h.

invoiceobjectOptional
pagesobjectOptional
styleobjectOptional
vendorsobjectOptional
entityobjectOptional
sessionIdstringOptional

Optional session ID to use for the token. If not provided, this token will not be associated with a session.

Response

This endpoint returns a string.

Errors