Authorization URL

It holds the details of client_id and scope of the resource to generate the grant token.

Possible Locations

• OAuth2

Overview

• Description
• Operation   required

Attributes

Example

Following is the sample of authorization url used for generating grant token for your resource,

    

        
copy
        

            

        
    
    

         
<authorization-url path="https://accounts.travel_bureau.com/oauth/v2/auth">
    <operation method="get" name="Authorization Request" category="action">
        <description>To use the Zoho CRM APIs, the users must authenticate the application to make API calls on their behalf with an access token.</description>
        <argument name="scope" location="param">
            <description>Data that your application wants to access. Refer to Scopes for more details.</description>
            <content>
                <encode type="text/plain" />
                <structure>
                    <property type="string"/>
                </structure>
            </content>
        </argument>
        <argument name="client_id" location="param">
            <description>Client ID(consumer key) that you obtained during client registration.</description>
            <content>
                <encode type="text/plain" />
                <structure>
                    <property type="string"/>
                </structure>
            </content>
        </argument>
        <argument name="response_type" location="param">
            <description>Enter code.</description>
            <content>
                <encode type="text/plain" />
                <structure>
                    <property type="string" values="code"/>
                </structure>
            </content>
        </argument>
        <argument name="access_type" location="param">
            <description>Enter access_type as online or offline.</description>
            <content>
                <encode type="text/plain" />
                <structure>
                    <property type="string" values="offline,online">
                        <description>If you want to generate the refresh token, set this value as offline.</description>
                    </property>
                </structure>
            </content>
        </argument>
        <argument name="redirect_uri" location="param">
            <description>Callback URL that you specified during client registration.</description>
            <content>
                <encode type="text/plain" />
                <structure>
                    <property type="string"/>
                </structure>
            </content>
        </argument>
        <response status="302" />
    </operation>
</authorization-url>