Begin the authorization flow
- Last Updated: March 6, 2025
- 1 minute read
- Hybrid Data Pipeline
- Version 4.6
- Documentation
Purpose
Begins the authorization flow to retrieve the authorization code. If the user is not already logged in, the user is prompted for Hybrid Data Pipeline credentials. Then, the user is prompted for consent to allow client application access to the resource.
URL
https://<myserver>:<port>/oauth2/authorize
Method
POST
URL Parameters
<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.
Response Definition
After the user grants consent, the Hybrid Data Pipeline server returns an authorization code to the client application.
Sample Server Failure Response
{
"error":{
"code":222206628,
"message":{
"lang":"en-US",
"value":"Problem creating OAuth Client Application at this time. Please try again at another time."
}
}
}
Authentication
Basic Authentication using Login ID and Password
Authorization
Any active Hybrid Data Pipeline user