IBM Cloud SDK Core  0.8.0
The IBM.Cloud.SDK.Core is a core project of SDKs generated using the IBM OpenAPI SDK generator.
IBM.Cloud.SDK.Core.Authentication.Iam.IamConfig Class Reference

Options for authenticating via the IAM (Identity Access Management) token service. This authentication mechanism allows an IAM access token to be obtained using a user-supplied apikey. The IAM access token is then specified as a Bearer Token within outgoing REST API requests. More...

Inheritance diagram for IBM.Cloud.SDK.Core.Authentication.Iam.IamConfig:
IBM.Cloud.SDK.Core.Authentication.IAuthenticatorConfig

Public Member Functions

void Validate ()
 Validate the configuration and throw an exception if validation fails. More...
 
 IamConfig (string apikey=null, string iamUrl=null, string userManagedAccessToken=null, bool? disableSslVerification=null, string iamClientId=null, string iamClientSecret=null)
 

Properties

string Apikey [get]
 
string IamUrl [get]
 
string UserManagedAccessToken [get]
 
bool DisableSslVerification [get]
 
string IamClientId [get]
 
string IamClientSecret [get]
 
string AuthenticationType [get]
 
- Properties inherited from IBM.Cloud.SDK.Core.Authentication.IAuthenticatorConfig
string AuthenticationType [get]
 Returns the authentication type associated with the AuthenticatorConfig instance. More...
 

Detailed Description

Options for authenticating via the IAM (Identity Access Management) token service. This authentication mechanism allows an IAM access token to be obtained using a user-supplied apikey. The IAM access token is then specified as a Bearer Token within outgoing REST API requests.

Constructor & Destructor Documentation

◆ IamConfig()

IBM.Cloud.SDK.Core.Authentication.Iam.IamConfig.IamConfig ( string  apikey = null,
string  iamUrl = null,
string  userManagedAccessToken = null,
bool?  disableSslVerification = null,
string  iamClientId = null,
string  iamClientSecret = null 
)
inline

Member Function Documentation

◆ Validate()

void IBM.Cloud.SDK.Core.Authentication.Iam.IamConfig.Validate ( )
inline

Validate the configuration and throw an exception if validation fails.

Implements IBM.Cloud.SDK.Core.Authentication.IAuthenticatorConfig.

Property Documentation

◆ Apikey

string IBM.Cloud.SDK.Core.Authentication.Iam.IamConfig.Apikey
get

◆ AuthenticationType

string IBM.Cloud.SDK.Core.Authentication.Iam.IamConfig.AuthenticationType
get

◆ DisableSslVerification

bool IBM.Cloud.SDK.Core.Authentication.Iam.IamConfig.DisableSslVerification
get

◆ IamClientId

string IBM.Cloud.SDK.Core.Authentication.Iam.IamConfig.IamClientId
get

◆ IamClientSecret

string IBM.Cloud.SDK.Core.Authentication.Iam.IamConfig.IamClientSecret
get

◆ IamUrl

string IBM.Cloud.SDK.Core.Authentication.Iam.IamConfig.IamUrl
get

◆ UserManagedAccessToken

string IBM.Cloud.SDK.Core.Authentication.Iam.IamConfig.UserManagedAccessToken
get

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