[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator

Post Authn Authorize

Description

Get access token for OAuth app in an organization.

Request

Request

URL

URL


post
https://console.navigator.vmware.com/cphub/api/auth/v2/authn/authorize
Copy

Query Parameters

Query Parameters

integer
accessTokenValiditySeconds Optional

The validity in seconds for the access token


string
orgId Required

Unique identifier (GUID) of the organization.


Header Parameters

Header Parameters

string
authorization Required

Basic auth with client credentials [Basic Base64_Encode(client_id:client_secret)]


Request Body

Request Body

InlineV2AuthnAuthorize_RequestBody of mimetype application/x-www-form-urlencoded Optional

The application/x-www-form-urlencoded form data type.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns AuthenticationTokens of type application/json
{
    "accessToken": "...",
    "idToken": "...",
    "refreshToken": "...",
    "returnUrl": "..."
}
string
accessToken Optional

The access token. This is a JWT token that grants access to resources.


string
idToken Optional

The ID Token is a signed JWT token returned from the authorization server and contains the user’s profile information, including the domain of the identity provider. This domain is used to obtain the identity provider URL. This token is used for optimization so the application can know the identity of the user, without having to make any additional network requests. This token can be generated via the Authorization Code flow only.


string
refreshToken Optional

The value of the Refresh token.


string
returnUrl Optional

Defines the return URL here.

Errors

Errors

400

Bad Request - The request is either incomplete or incorrect


401

Unauthorized - The user is not authorized to use the API


403

Forbidden - User does not have permission for this operation


500

Internal Server Error - An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl -X POST -H "authorization: string" -H "Content-Type: application/x-www-form-urlencoded" -d '{}' https://console.navigator.vmware.com/cphub/api/auth/v2/authn/authorize?orgId=string


[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator
Feedback

Was this page helpful?