auth_callback_cc.h File Reference

Defines auth callback functions. More...

#include <stddef.h>
#include <stdint.h>
#include "mip_cc/identity_cc.h"
#include "mip_cc/mip_macros_cc.h"

Go to the source code of this file.

Classes
struct	mip_cc_oauth2_challenge
	Information provided by a server to generate an OAuth2 token. More...

Functions
	MIP_CC_CALLBACK (mip_cc_auth_callback, bool, const mip_cc_identity *, const mip_cc_oauth2_challenge *, const void *, uint8_t *, const int64_t, int64_t *)
	callback function definition for acquiring OAuth2 token

Detailed Description

Defines auth callback functions.

Function Documentation

MIP_CC_CALLBACK()

MIP_CC_CALLBACK	(	mip_cc_auth_callback	,
		bool	,
		const mip_cc_identity *	,
		const mip_cc_oauth2_challenge *	,
		const void *	,
		uint8_t *	,
		const int64_t	,
		int64_t *	)

callback function definition for acquiring OAuth2 token

Parameters

identity	The email address for whom token will be acquired
challenge	OAuth2 challenge
context	Opaque application context that was passed to the MIP API that resulted in this auth callback
tokenBuffer	[Output] Buffer into which token will be copied. If null, 'actualTokenSize' will be populated, but no bytes will be copied
tokenBufferSize	Size (in bytes) of output buffer
actualTokenSize	[Output] Actual size (in bytes) of token

Returns

True is token was retrieved, else false