Skip to main content

Overview

Allows the client to (pre-)authorize access to (or remove authorization to access) one of its Legal Identities to a remote party. When (if) the remote party requests the ID, the broker will return it automatically, if already authorized. If not authorized, a petition to access the identity will be sent to the client for manual approval (or rejection).

HTTP request

POST /Agent/Legal/AuthorizeAccessToId

Authentication

Requires a valid JWT bearer token.

Request (JSON)

{
	"legalId": Required(Str(PLegalId)),
	"remoteId": Required(Str(PRemoteId)),
	"authorized": Required(Boolean(PAuthorized))
}

Input parameters

ParameterDescription
PLegalIdIdentifier of the corresponding Legal Identity of the client.
PRemoteIdIdentifier of the Legal Identity of the corresponding remote entity, or its Bare JID.
PAuthorizedIf the remote entity is authorized access to the corresponding identity or not.

Response (JSON)

{
}

Notes

This endpoint uses the request schema notation described in Pattern matching.