IamRequestBasedAuthenticatorImmutable (sdk-core 9.24.3 API)

java.lang.Object
- com.ibm.cloud.sdk.core.security.AuthenticatorBase
- - com.ibm.cloud.sdk.core.security.TokenRequestBasedAuthenticatorImmutable<IamToken,IamToken>
  - - com.ibm.cloud.sdk.core.security.IamRequestBasedAuthenticatorImmutable

All Implemented Interfaces:

Authenticator

Direct Known Subclasses:

IamAssumeAuthenticator, IamRequestBasedAuthenticator
```
public abstract class IamRequestBasedAuthenticatorImmutable
extends TokenRequestBasedAuthenticatorImmutable<IamToken,IamToken>
implements Authenticator
```
This class contains code that is common to all authenticators that need to interact with the IAM token service to obtain an access token.

Field Summary
- Fields inherited from class com.ibm.cloud.sdk.core.security.AuthenticatorBase
  ERRORMSG_ACCOUNTID_PROP_ERROR, ERRORMSG_ATLEAST_ONE_PROP_ERROR, ERRORMSG_ATMOST_ONE_PROP_ERROR, ERRORMSG_EXCLUSIVE_PROP_ERROR, ERRORMSG_PROP_INVALID, ERRORMSG_PROP_INVALID_BOOL, ERRORMSG_PROP_INVALID_INTEGER_VALUE, ERRORMSG_PROP_MISSING, ERRORMSG_REQ_FAILED
- Fields inherited from interface com.ibm.cloud.sdk.core.security.Authenticator
  AUTHTYPE_BASIC, AUTHTYPE_BEARER_TOKEN, AUTHTYPE_CONTAINER, AUTHTYPE_CP4D, AUTHTYPE_CP4D_SERVICE, AUTHTYPE_CP4D_SERVICE_INSTANCE, AUTHTYPE_IAM, AUTHTYPE_IAM_ASSUME, AUTHTYPE_MCSP, AUTHTYPE_MCSPV2, AUTHTYPE_NOAUTH, AUTHTYPE_VPC, PROPNAME_APIKEY, PROPNAME_AUTH_TYPE, PROPNAME_BEARER_TOKEN, PROPNAME_CALLER_EXT_CLAIM, PROPNAME_CLIENT_ID, PROPNAME_CLIENT_SECRET, PROPNAME_CR_TOKEN_FILENAME, PROPNAME_DISABLE_SSL, PROPNAME_DISPLAY_NAME, PROPNAME_EXPIRATION_TIME, PROPNAME_IAM_ACCOUNT_ID, PROPNAME_IAM_PROFILE_CRN, PROPNAME_IAM_PROFILE_ID, PROPNAME_IAM_PROFILE_NAME, PROPNAME_INCLUDE_BUILTIN_ACTIONS, PROPNAME_INCLUDE_CUSTOM_ACTIONS, PROPNAME_INCLUDE_ROLES, PROPNAME_PASSWORD, PROPNAME_PERMISSIONS, PROPNAME_PREFIX_ROLES, PROPNAME_SCOPE, PROPNAME_SCOPE_COLLECTION_TYPE, PROPNAME_SCOPE_ID, PROPNAME_SERVICE_BROKER_SECRET, PROPNAME_SERVICE_INSTANCE_ID, PROPNAME_UID, PROPNAME_URL, PROPNAME_USERNAME

Constructor Summary

Constructors
Constructor Description

IamRequestBasedAuthenticatorImmutable()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getClientId()`
`java.lang.String`	`getClientSecret()`
`java.lang.String`	`getScope()`
`java.lang.String`	`getURL()`
`void`	`validate()`	Validates the configuration properties associated with the Authenticator.

Methods inherited from class com.ibm.cloud.sdk.core.security.TokenRequestBasedAuthenticatorImmutable
authenticate, authenticationType, getClient, getDisableSSLVerification, getHeaders, getProxy, getProxyAuthenticator, getToken, requestToken

Methods inherited from class com.ibm.cloud.sdk.core.security.AuthenticatorBase
constructBasicAuthHeader, constructBearerTokenAuthHeader

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.cloud.sdk.core.security.Authenticator
authenticate, authenticationType

- Constructor Detail
  - IamRequestBasedAuthenticatorImmutable
```
public IamRequestBasedAuthenticatorImmutable()
```
- Method Detail
  - validate
```
public void validate()
```
    Description copied from class: TokenRequestBasedAuthenticatorImmutable
    
    Validates the configuration properties associated with the Authenticator. Each concrete subclass must implement this method.
    
    Specified by:
    
    validate in interface Authenticator
    
    Specified by:
    
    validate in class TokenRequestBasedAuthenticatorImmutable<IamToken,IamToken>
  - getURL
```
public java.lang.String getURL()
```
    Returns:
    
    the URL configured on this Authenticator.
  - getClientId
```
public java.lang.String getClientId()
```
    Returns:
    
    the clientId configured on this Authenticator.
  - getClientSecret
```
public java.lang.String getClientSecret()
```
    Returns:
    
    the clientSecret configured on this Authenticator.
  - getScope
```
public java.lang.String getScope()
```
    Returns:
    
    the scope parameter