A response to a client or user introspect application operation. More...

#include <IntrospectAppResult.h>

Public Member Functions
const std::string &	GetClientId () const
	Gets the identifier for the client or application.

void	SetClientId (std::string client_id)
	Sets the identifier for the client or application.

const std::string &	GetName () const
	Gets the human-readable name of the client.

void	SetName (std::string name)
	Sets the name of the client.

const std::string &	GetDescription () const
	Gets the prose description of the client.

void	SetDescription (std::string description)
	Sets the prose description of the client.

const std::vector< std::string > &	GetRedirectUris () const
	Gets a list of redirect URIs.

void	SetReditectUris (std::vector< std::string > uris)
	Sets the redirect URIs.

const std::vector< std::string > &	GetAllowedScopes () const
	Gets a list of strings that represent scopes.

void	SetAllowedScopes (std::vector< std::string > scopes)
	Sets the list of the scopes.

const std::string &	GetTokenEndpointAuthMethod () const
	Gets the token endpoint authentication method.

void	SetTokenEndpointAuthMethod (std::string method)
	Sets the token endpoint authentication method.

const std::string &	GetTokenEndpointAuthMethodReason () const
	Gets the token endpoint authentication method reason.

void	SetTokenEndpointAuthMethodReason (std::string reason)
	Sets token endpoint authentication method reason.

bool	GetDobRequired () const
	Gets the DOB requirement.

void	SetDobRequired (bool is_required)
	Sets the DOB requirement.

int	GetTokenDuration () const
	Gets the default duration in seconds for the token issued to this application.

void	SetTokenDuration (int duration)
	Sets the default duration in seconds for the token.

const std::vector< std::string > &	GetReferrers () const
	Gets a list of referrer URLs to register or that were registered with the application.

void	SetReferrers (std::vector< std::string > urls)
	Sets the list of referrer URLs to register or that were registered with the application.

const std::string &	GetStatus () const
	Gets the status of the application.

void	SetStatus (std::string status)
	Sets the status of the application.

bool	GetAppCodeEnabled () const
	Checks if the application codes are enabled.

void	SetAppCodeEnabled (bool is_enabled)
	Sets the application codes if they are enabled.

time_t	GetCreatedTime () const
	Gets the timestamp (milliseconds since the Unix epoch) of when the application was created.

void	SetCreatedTime (time_t time)
	Sets the timestamp (milliseconds since the Unix epoch) of when the application was created.

const std::string &	GetRealm () const
	Gets the realm to which the application belongs.

void	SetRealm (std::string realm)
	Sets the realm to which the application belongs.

const std::string &	GetType () const
	Gets the application type.

void	SetType (std::string type)
	Sets the application type.

const std::vector< std::string > &	GetResponseTypes () const
	Gets a list of response types.

void	SetResponseTypes (std::vector< std::string > types)
	Sets the list of response types.

const std::string &	GetTier () const
	Gets a rate limit tier to configure the application.

void	SetTier (std::string tier)
	Sets the rate limit tier to configure the application.

const std::string &	GetHRN () const
	Gets the HRN of the application.

void	SetHrn (std::string hrn)
	Sets the HRN of the application.

Detailed Description

A response to a client or user introspect application operation.

Member Function Documentation

◆ GetAllowedScopes()

const std::vector< std::string > & olp::authentication::IntrospectAppResult::GetAllowedScopes ( ) const

inline

Gets a list of strings that represent scopes.

This field is required when the response types are non-empty.

Returns: The list of strings that represent the scopes.

◆ GetAppCodeEnabled()

bool olp::authentication::IntrospectAppResult::GetAppCodeEnabled ( ) const

inline

Checks if the application codes are enabled.

Returns: True if the application codes are enabled; false otherwise.

◆ GetClientId()

const std::string & olp::authentication::IntrospectAppResult::GetClientId ( ) const

inline

Gets the identifier for the client or application.

Returns: The client identifier.

◆ GetCreatedTime()

time_t olp::authentication::IntrospectAppResult::GetCreatedTime ( ) const

inline

Gets the timestamp (milliseconds since the Unix epoch) of when the application was created.

Returns: The epoch time when the application was created.

◆ GetDescription()

const std::string & olp::authentication::IntrospectAppResult::GetDescription ( ) const

inline

Gets the prose description of the client.

Returns: The client description.

◆ GetDobRequired()

bool olp::authentication::IntrospectAppResult::GetDobRequired ( ) const

inline

Gets the DOB requirement.

Returns: If true, the user must provide their DOB; if false, the user can use self-service and specify "yes I am over age X".

◆ GetHRN()

const std::string & olp::authentication::IntrospectAppResult::GetHRN ( ) const

inline

Gets the HRN of the application.

Returns: The application HRN.

◆ GetName()

const std::string & olp::authentication::IntrospectAppResult::GetName ( ) const

inline

Gets the human-readable name of the client.

Returns: The client name.

◆ GetRealm()

const std::string & olp::authentication::IntrospectAppResult::GetRealm ( ) const

inline

Gets the realm to which the application belongs.

Returns: The application realm.

◆ GetRedirectUris()

const std::vector< std::string > & olp::authentication::IntrospectAppResult::GetRedirectUris ( ) const

inline

Gets a list of redirect URIs.

Should be fully qualified HTTPS URIs without any fragments (HTTP is only supported for the localhost development). At least one redirect URI should be registered if the response types are non-empty.

Returns: The list of the redirect URIs.

◆ GetReferrers()

const std::vector< std::string > & olp::authentication::IntrospectAppResult::GetReferrers ( ) const

inline

Gets a list of referrer URLs to register or that were registered with the application.

When creating or updating: if the parameter is not present, the current value(s) are unchanged. If an empty list is specified, the current value(s) will be reset to the empty list.

A value can contain 1-255 characters. Wildcards are NOT allowed. The only valid characters are alphanumerics, '-', '_', '.', '/'. The protocol is NOT specified, that is, http:// or https:// is not allowed.

Examples: here.com, localhost, 127.0.0.1, www.facebook.com/hello/world/.

Returns: The list of referrer URLs to register or that were registered with the application.

◆ GetResponseTypes()

const std::vector< std::string > & olp::authentication::IntrospectAppResult::GetResponseTypes ( ) const

inline

Gets a list of response types.

Returns: The list of response types.

◆ GetStatus()

const std::string & olp::authentication::IntrospectAppResult::GetStatus ( ) const

inline

Gets the status of the application.

Returns: The status of the application.

◆ GetTier()

const std::string & olp::authentication::IntrospectAppResult::GetTier ( ) const

inline

Gets a rate limit tier to configure the application.

Returns: The application rate limit tier.

◆ GetTokenDuration()

int olp::authentication::IntrospectAppResult::GetTokenDuration ( ) const

inline

Gets the default duration in seconds for the token issued to this application.

It has to be a non-zero value less than or equal to 72 hours (259200).

Returns: The token duration in seconds.

◆ GetTokenEndpointAuthMethod()

const std::string & olp::authentication::IntrospectAppResult::GetTokenEndpointAuthMethod ( ) const

inline

Gets the token endpoint authentication method.

Returns: The token endpoint authentication method.

◆ GetTokenEndpointAuthMethodReason()

const std::string & olp::authentication::IntrospectAppResult::GetTokenEndpointAuthMethodReason ( ) const

inline

Gets the token endpoint authentication method reason.

Returns: The token endpoint authentication method reason.

◆ GetType()

const std::string & olp::authentication::IntrospectAppResult::GetType ( ) const

inline

Gets the application type.

Returns: The application type.

◆ SetAllowedScopes()

void olp::authentication::IntrospectAppResult::SetAllowedScopes ( std::vector< std::string > scopes )

inline

Sets the list of the scopes.

Parameters

scopes The list of strings that represent the scopes.

◆ SetAppCodeEnabled()

void olp::authentication::IntrospectAppResult::SetAppCodeEnabled ( bool is_enabled )

inline

Sets the application codes if they are enabled.

Parameters

is_enabled True if the application codes are enabled; false otherwise.

◆ SetClientId()

void olp::authentication::IntrospectAppResult::SetClientId ( std::string client_id )

inline

Sets the identifier for the client or application.

Parameters

client_id The client identifier.

◆ SetCreatedTime()

void olp::authentication::IntrospectAppResult::SetCreatedTime ( time_t time )

inline

Sets the timestamp (milliseconds since the Unix epoch) of when the application was created.

Parameters

time	The epoch time when the application was created.

◆ SetDescription()

void olp::authentication::IntrospectAppResult::SetDescription ( std::string description )

inline

Sets the prose description of the client.

Parameters

description The client description.

◆ SetDobRequired()

void olp::authentication::IntrospectAppResult::SetDobRequired ( bool is_required )

inline

Sets the DOB requirement.

Parameters

is_required If true, the user must provide their DOB; if false, the user can use self-service and specify "yes I am over age X".

◆ SetHrn()

void olp::authentication::IntrospectAppResult::SetHrn ( std::string hrn )

inline

Sets the HRN of the application.

Parameters

hrn	The application HRN.

◆ SetName()

void olp::authentication::IntrospectAppResult::SetName ( std::string name )

inline

Sets the name of the client.

Parameters

name	The client name.

◆ SetRealm()

void olp::authentication::IntrospectAppResult::SetRealm ( std::string realm )

inline

Sets the realm to which the application belongs.

Parameters

realm The application realm.

◆ SetReditectUris()

void olp::authentication::IntrospectAppResult::SetReditectUris ( std::vector< std::string > uris )

inline

Sets the redirect URIs.

Parameters

uris	The list of the redirect URIs.

◆ SetReferrers()

void olp::authentication::IntrospectAppResult::SetReferrers ( std::vector< std::string > urls )

inline

Sets the list of referrer URLs to register or that were registered with the application.

Parameters

urls	The llist of referrer URLs.

◆ SetResponseTypes()

void olp::authentication::IntrospectAppResult::SetResponseTypes ( std::vector< std::string > types )

inline

Sets the list of response types.

Parameters

types The list of response types.

◆ SetStatus()

void olp::authentication::IntrospectAppResult::SetStatus ( std::string status )

inline

Sets the status of the application.

Parameters

status The status of the application.

◆ SetTier()

void olp::authentication::IntrospectAppResult::SetTier ( std::string tier )

inline

Sets the rate limit tier to configure the application.

Parameters

tier	The application rate limit tier.

◆ SetTokenDuration()

void olp::authentication::IntrospectAppResult::SetTokenDuration ( int duration )

inline

Sets the default duration in seconds for the token.

Parameters

duration The token duration in seconds.

◆ SetTokenEndpointAuthMethod()

void olp::authentication::IntrospectAppResult::SetTokenEndpointAuthMethod ( std::string method )

inline

Sets the token endpoint authentication method.

Parameters

method The token endpoint authentication method.

◆ SetTokenEndpointAuthMethodReason()

void olp::authentication::IntrospectAppResult::SetTokenEndpointAuthMethodReason ( std::string reason )

inline

Sets token endpoint authentication method reason.

Parameters

reason The token endpoint authentication method reason.

◆ SetType()

void olp::authentication::IntrospectAppResult::SetType ( std::string type )

inline

Sets the application type.

Parameters

type	The application type.

The documentation for this class was generated from the following file:

olp-cpp-sdk-authentication/include/olp/authentication/IntrospectAppResult.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetAllowedScopes()

◆ GetAppCodeEnabled()

◆ GetClientId()

◆ GetCreatedTime()

◆ GetDescription()

◆ GetDobRequired()

◆ GetHRN()

◆ GetName()

◆ GetRealm()

◆ GetRedirectUris()

◆ GetReferrers()

◆ GetResponseTypes()

◆ GetStatus()

◆ GetTier()

◆ GetTokenDuration()

◆ GetTokenEndpointAuthMethod()

◆ GetTokenEndpointAuthMethodReason()

◆ GetType()

◆ SetAllowedScopes()

◆ SetAppCodeEnabled()

◆ SetClientId()

◆ SetCreatedTime()

◆ SetDescription()

◆ SetDobRequired()

◆ SetHrn()

◆ SetName()

◆ SetRealm()

◆ SetReditectUris()

◆ SetReferrers()

◆ SetResponseTypes()

◆ SetStatus()

◆ SetTier()

◆ SetTokenDuration()

◆ SetTokenEndpointAuthMethod()

◆ SetTokenEndpointAuthMethodReason()

◆ SetType()