Virtru SDK for C#  2.8.0
Virtru C# SDK module - Create, Read, and Manage TDF3 Files
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Virtru.SDK.CredentialsOidc Class Reference
Inheritance diagram for Virtru.SDK.CredentialsOidc:
Virtru.SDK.Credentials

Public Member Functions

 CredentialsOidc (string owner, string clientId, string clientSecret, string clientPubkey, string organizationName, string oidcEndpoint)
 
 CredentialsOidc (string owner, string refreshToken, string clientPubkey, string organizationName, string oidcEndpoint)
 
 CredentialsOidc (string userId, StringStringMap headers)
 
 CredentialsOidc (string userId, string authorizationString, string clientToken)
 
override StringStringMap generateAuthHeaders (string url, string method, string body, StringStringMap headers, string date)
 
override string getUserId ()
 
override string str ()
 
string getAccessToken ()
 
void Dispose ()
 
CredentialsType getType ()
 
string getTypeStr ()
 

Protected Member Functions

override void Dispose (bool disposing)
 

Protected Attributes

bool swigCMemOwn
 

Package Functions

 CredentialsOidc (global::System.IntPtr cPtr, bool cMemoryOwn)
 

Static Package Functions

static
global::System.Runtime.InteropServices.HandleRef 
getCPtr (CredentialsOidc obj)
 
static
global::System.Runtime.InteropServices.HandleRef 
swigRelease (CredentialsOidc obj)
 
static
global::System.Runtime.InteropServices.HandleRef 
getCPtr (Credentials obj)
 
static
global::System.Runtime.InteropServices.HandleRef 
swigRelease (Credentials obj)
 

Private Attributes

global::System.Runtime.InteropServices.HandleRef swigCPtr
 

Constructor & Destructor Documentation

Virtru.SDK.CredentialsOidc.CredentialsOidc ( global::System.IntPtr  cPtr,
bool  cMemoryOwn 
)
inlinepackage
Virtru.SDK.CredentialsOidc.CredentialsOidc ( string  owner,
string  clientId,
string  clientSecret,
string  clientPubkey,
string  organizationName,
string  oidcEndpoint 
)
inline

Constructor

Parameters
owner- Ignored, redundant, kept for backward compatibility
clientId- The OIDC clientcredential client id
clientSecret- The OIDC clientcredential client secret
organizationName- The org/realm mapped to this client in the IdP
oidcEndpoint- The OIDC IdP endpoint to request tokens from
Virtru.SDK.CredentialsOidc.CredentialsOidc ( string  owner,
string  refreshToken,
string  clientPubkey,
string  organizationName,
string  oidcEndpoint 
)
inline

Constructor

Parameters
owner- Ignored, redundant, kept for backward compatibility
refreshToken- A valid OIDC refresh token as previously issued by 'oidcEndpoint' - this will be exchanged for an access token with updated Virtru claims
organizationName- The org/realm mapped to this client in the IdP
oidcEndpoint- The OIDC IdP endpoint to request tokens from
Virtru.SDK.CredentialsOidc.CredentialsOidc ( string  userId,
StringStringMap  headers 
)
inline

Constructor

Parameters
userId- The user id.
Virtru.SDK.CredentialsOidc.CredentialsOidc ( string  userId,
string  authorizationString,
string  clientToken 
)
inline

Constructor

Parameters
userId- The userId associated with the token
authorizationString- The auth string to be used
clientToken- A valid OIDC token as previously issued

Member Function Documentation

override void Virtru.SDK.CredentialsOidc.Dispose ( bool  disposing)
inlineprotectedvirtual

Reimplemented from Virtru.SDK.Credentials.

void Virtru.SDK.Credentials.Dispose ( )
inlineinherited
override StringStringMap Virtru.SDK.CredentialsOidc.generateAuthHeaders ( string  url,
string  method,
string  body,
StringStringMap  headers,
string  date 
)
inlinevirtual

Create the header key/value pairs that should be added to the request to establish authorization

Parameters
url- The full url for the request, including protocol prefix and parameter information
method- The method for the request, such as 'get' or 'post'
body- The body for the request, can be an empty string if there is no body content
headers- a set of http header key/value pairs that should be included in calculations
date- the date string that should be used in calculations
Returns
- map of key/value http header pairs

Reimplemented from Virtru.SDK.Credentials.

string Virtru.SDK.CredentialsOidc.getAccessToken ( )
inline

Get the access token associated with these credentials

Returns
- The access token as a string

static global.System.Runtime.InteropServices.HandleRef Virtru.SDK.CredentialsOidc.getCPtr ( CredentialsOidc  obj)
inlinestaticpackage
static global.System.Runtime.InteropServices.HandleRef Virtru.SDK.Credentials.getCPtr ( Credentials  obj)
inlinestaticpackageinherited
CredentialsType Virtru.SDK.Credentials.getType ( )
inlineinherited

Get the type of this credentials object, as specified by the CredentialsType enum value

Returns
- The type enum value of this credentials instance

string Virtru.SDK.Credentials.getTypeStr ( )
inlineinherited

Get the type of this credentials object, as a string representation of the CredentialsType

Returns
- The type of this credentials instance as a string

override string Virtru.SDK.CredentialsOidc.getUserId ( )
inlinevirtual

Get the userId associated with these credentials

Reimplemented from Virtru.SDK.Credentials.

override string Virtru.SDK.CredentialsOidc.str ( )
inlinevirtual

Get a debug-friendly string describing this credentials object

Returns
- The type of this credentials instance as a string

Reimplemented from Virtru.SDK.Credentials.

static global.System.Runtime.InteropServices.HandleRef Virtru.SDK.CredentialsOidc.swigRelease ( CredentialsOidc  obj)
inlinestaticpackage
static global.System.Runtime.InteropServices.HandleRef Virtru.SDK.Credentials.swigRelease ( Credentials  obj)
inlinestaticpackageinherited

Member Data Documentation

bool Virtru.SDK.Credentials.swigCMemOwn
protectedinherited
global.System.Runtime.InteropServices.HandleRef Virtru.SDK.CredentialsOidc.swigCPtr
private

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