Skip to main content

GenerateComponentTokenInput

Selects the embedded component that needs access and optionally supplies a resource scope.

Fields

FieldTypeRequiredDefaultDescription
componentComponentTokenComponent!YesComponent that selects the server-owned capability allow list
documentViewerDocumentViewerComponentTokenScopeInputNoOptional resource scope for the document viewer; exists for forward compatibility but not currently enforced
signerSignerComponentTokenScopeInputNoResource scope for the signer component; specifies which recipient this token is for

Examples

input: {
component: LS_DOCUMENT_VIEWER
}
input: {
component: LS_SIGNER
signer: {
recipientId: "cmVjMTIzNDU2"
}
}

Or with a session ID:

input: {
component: LS_SIGNER
signer: {
sessionId: "c2VzMTIzNDU2"
}
}

Provide either recipientId or sessionId in the signer scope, but not both.

Export This Article

Save a copy of this page as PDF or plain text.