Skip to main content

requestOAuth2CredentialAuthorization Mutation

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] when a value for 'customer' does not exist on the object. 2. The signed-in User has any of the following permissions for the associated Organization: [org_manage_customers, org_manage_integrations] when a value for 'customer' exists on the object. 3. The signed-in User has any of the following permissions for the object's 'customer' attribute: [customer_edit] when a value for 'customer' exists on the object.

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)#