requestOAuth2CredentialAuthorization

Sends an email that requests the recipient to complete the OAuth2 flow for
the specified Credential.

Access is permitted when any of the following condition(s) are met: 1. The signed-in User has any of the following permissions for the associated Organization: [org_manage_integrations, org_create_integrations] when 'customer' is not provided in the access function context. 2. The signed-in User has any of the following permissions for the associated Organization: [org_manage_customers, org_manage_integrations, org_create_integrations] when 'customer' is provided in the access function context. 3. The signed-in User has any of the following permissions for the access function context object 'customer': [customer_edit] when 'customer' is provided in the access function context.

Input fields (RequestOAuth2CredentialAuthorizationInput!)

ArgumentTypeDescription
emailStringThe email of the recipient who will complete the OAuth2 authorization request.
messageStringThe message that will be sent to the recipient of the email.
idIDThe ID of the Credential to mutate.
clientMutationIdStringA unique identifier for the client performing the mutation.

Return fields (RequestOAuth2CredentialAuthorizationPayload)

credential (Credential)
errors ([ErrorType])
clientMutationId (String)
Last updated on