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

OAuth App Access Token

Description

Get access token, in the specified org, for an Oauth app/service account using the Oauth app’s id and password (a.k.a client credentials).

Request

Request

URL

URL


post
https://{api_host}/v1/authn/accounts/{orgId}/accesstoken
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.


Request Body

Request Body

ClientCredentials of mimetype application/json Optional
{
    "ClientCredentials": {
        "clientId": "...",
        "clientSecret": "..."
    },
    "clientId": "...",
    "clientSecret": "..."
}
string
clientId Optional

The unique identifier of the client.


string
clientSecret Optional

The value of the client secret.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created

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

The return URL.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"ClientCredentials":{"clientId":"...","clientSecret":"..."},"clientId":"...","clientSecret":"..."}' https://{api_host}/v1/authn/accounts/{orgId}/accesstoken
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: body


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

Was this page helpful?