Table of Contents
/Legal/AuthorizeAccessToId
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).
JSON
- Request
{ "legalId": Required(Str(PLegalId)), "remoteId": Required(Str(PRemoteId)), "authorized": Required(Boolean(PAuthorized)) }
- Response (if successful)
{ }
XML
- Request
<AuthorizeAccessToId xmlns="https://waher.se/Schema/BrokerAgent.xsd" legalId=(Required(Str(PLegalId))) remoteId=(Required(Str(PRemoteId))) authorized=(Required(Boolean(PAuthorized)))/>
- Response (if successful)
<AckResponse xmlns="https://waher.se/Schema/BrokerAgent.xsd" />
Input Parameters
Parameter | Description |
---|---|
PLegalId |
Identifier of the corresponding Legal Identity of the client. |
PRemoteId |
Identifier of the Legal Identity of the corresponding remote entity, or its Bare JID. |
PAuthorized |
If the remote entity is authorized access to the corresponding identity or not. |
Javascript Library
Use the following asynchronous method in the Javascript Library, to call this resource.
var Response = await AgentAPI.Legal.AuthorizeAccessToId(LegalId, RemoteId, Authorized);