EOS_Auth_VerifyIdToken

EOS API reference page for EOS_Auth_VerifyIdToken

Choose your implementation method:

C

C#

This function is part of the Auth Interface.

Remarks

Verify a given ID token for authenticity and validity.

Parameters

EOS_Auth_VerifyIdToken

Parameter Type And Name

Usage Information

EOS_HAuth Handle

const EOS_Auth_VerifyIdTokenOptions* Options

Structure containing information about the ID token to verify.

void* ClientData

Arbitrary data that is passed back to you in the CompletionDelegate

const EOS_Auth_OnVerifyIdTokenCallback CompletionDelegate

A callback that is fired when the operation completes, either successfully or in error.

This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the void* parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_Auth_OnVerifyIdTokenCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed into EOS_Auth_VerifyIdToken.

Callback Parameters

EOS_Auth_OnVerifyIdTokenCallback

Parameter Type And Name

Usage Information

const EOS_Auth_VerifyIdTokenCallbackInfo* Data

A EOS_Auth_VerifyIdTokenCallbackInfo containing the output information and result.

Related API Members

This function is part of the Auth Interface.

Remarks

Verify a given ID token for authenticity and validity.

Parameters

Auth.AuthInterface.VerifyIdToken

Parameter Type And Name

Usage Information

VerifyIdTokenOptions options

Structure containing information about the ID token to verify.

object clientData

Arbitrary data that is passed back to you in the CompletionDelegate

OnVerifyIdTokenCallback completionDelegate

A callback that is fired when the operation completes, either successfully or in error.

This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionDelegate parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the object parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.

Callback Function Information

Because this function is asynchronous, it employs a callback of type Auth.OnVerifyIdTokenCallback to report the results of its operation.

Callback Remarks

Function prototype definition for callbacks passed into {AuthInterface.VerifyIdToken}.

Callback Parameters

Auth.OnVerifyIdTokenCallback

Parameter Type And Name

Usage Information

VerifyIdTokenCallbackInfo data

A EOS_Auth_VerifyIdTokenCallbackInfo containing the output information and result.

Related API Members

Tags