Skip to content

Latest commit

 

History

History
180 lines (85 loc) · 2.57 KB

ExternalAuthorization.md

File metadata and controls

180 lines (85 loc) · 2.57 KB
Raw

CBS\SmarterU\DataTypes\ExternalAuthorization

The ExternalAuthorization class represents the information returned by the SmarterU API when a user logs in through a third-party interface using the RequestExternalAuthorization method.

Methods

Name Description
getAuthKey Get the one-time authorization key.
getRedirectPath Get the full path to redirect the user to SmarterU.
getRequestKey Get the unique identifier of the authorization request.
setAuthKey Set the one-time authorization key.
setRedirectPath Set the full path to redirect the user to SmarterU.
setRequestKey Set the unique identifier of the authorization request.

ExternalAuthorization::getAuthKey

Description

public getAuthKey (void)

Get the one-time authorization key.

Parameters

This function has no parameters.

Return Values

string

The authorization key

ExternalAuthorization::getRedirectPath

Description

public getRedirectPath (void)

Get the full path to redirect the user to SmarterU.

Parameters

This function has no parameters.

Return Values

string

The full path to redirect the user to SmarterU

ExternalAuthorization::getRequestKey

Description

public getRequestKey (void)

Get the unique identifier of the authorization request.

Parameters

This function has no parameters.

Return Values

string

The unique identifier of the authorization request

ExternalAuthorization::setAuthKey

Description

public setAuthKey (string $authKey)

Set the one-time authorization key.

Parameters

  • (string) $authKey : The authorization key

Return Values

self

ExternalAuthorization::setRedirectPath

Description

public setRedirectPath (string $redirectPath)

Set the full path to redirect the user to SmarterU.

Parameters

  • (string) $redirectPath : The full path to redirect the user to SmarterU

Return Values

void

ExternalAuthorization::setRequestKey

Description

public setRequestKey (string $requestKey)

Set the unique identifier of the authorization request.

Parameters

  • (string) $requestKey : The unique identifier of the authorization

Return Values

self