YM REST Services

<back to all web services

OIDCGetAccessToken

The following routes are available for this service:
POST/OAuth/OIDC/GetAccessTokenReturns the access token for either an authorization code or refresh token.
OIDCGetAccessToken Parameters:
NameParameterData TypeRequiredDescription
grant_typebodyOIDCGrantTypeYes

Allowable Values

  • authorization_code
  • refresh_token
scopebodystringNo
codebodystringNo
refresh_tokenbodystringNo
redirect_uribodystringNo
client_idbodystringNo
client_secretbodystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
OIDCGetAccessTokenResponse Parameters:
NameParameterData TypeRequiredDescription
access_tokenformstringNo
token_typeformstringNo
refresh_tokenformstringNo
expires_informlong?No
id_tokenformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /OAuth/OIDC/GetAccessToken HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	grant_type: authorization_code,
	scope: String,
	code: String,
	refresh_token: String,
	redirect_uri: String,
	client_id: String,
	client_secret: String,
	UsingRedis: True,
	AppInitTime: 2024-05-03T08:24:51.9748751-04:00,
	ServerID: WS-6-183-431,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2024-05-03T08:41:03.5705299-04:00,
	Device: Desktop
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	access_token: String,
	token_type: String,
	refresh_token: String,
	expires_in: 0,
	id_token: String,
	UsingRedis: True,
	AppInitTime: 2024-05-03T08:24:51.9748751-04:00,
	ServerID: WS-6-183-431,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2024-05-03T08:41:03.5914433-04:00,
	Device: Desktop
}