Class EntraOAuthCredentials

java.lang.Object
com.cloudbees.plugins.credentials.BaseCredentials
com.cloudbees.plugins.credentials.impl.BaseStandardCredentials
io.jenkins.plugins.entraoauth.EntraOAuthCredentials
All Implemented Interfaces:
com.cloudbees.plugins.credentials.common.IdCredentials, com.cloudbees.plugins.credentials.common.StandardCredentials, com.cloudbees.plugins.credentials.common.StandardUsernameCredentials, com.cloudbees.plugins.credentials.common.UsernameCredentials, com.cloudbees.plugins.credentials.Credentials, com.google.jenkins.plugins.credentials.oauth.OAuth2Credentials<com.google.jenkins.plugins.credentials.oauth.OAuth2ScopeRequirement>, com.google.jenkins.plugins.credentials.oauth.StandardUsernameOAuth2Credentials<com.google.jenkins.plugins.credentials.oauth.OAuth2ScopeRequirement>, ExtensionPoint, Describable<com.cloudbees.plugins.credentials.Credentials>, Serializable
public class EntraOAuthCredentials extends com.cloudbees.plugins.credentials.impl.BaseStandardCredentials implements com.google.jenkins.plugins.credentials.oauth.StandardUsernameOAuth2Credentials<com.google.jenkins.plugins.credentials.oauth.OAuth2ScopeRequirement>
Microsoft Entra OAuth credentials with pluggable authentication methods.
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    EntraOAuthCredentials.DescriptorImpl
     

    Nested classes/interfaces inherited from class com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

    com.cloudbees.plugins.credentials.impl.BaseStandardCredentials.BaseStandardCredentialsDescriptor

    Nested classes/interfaces inherited from interface ExtensionPoint

    ExtensionPoint.LegacyInstancesAreScopedToHudson

    Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials

    com.cloudbees.plugins.credentials.common.IdCredentials.Helpers

    Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.StandardCredentials

    com.cloudbees.plugins.credentials.common.StandardCredentials.NameProvider

    Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.StandardUsernameCredentials

    com.cloudbees.plugins.credentials.common.StandardUsernameCredentials.NameProvider

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_AUTHORITY_HOST
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    EntraOAuthCredentials(com.cloudbees.plugins.credentials.CredentialsScope scope, String id, String description, String tenantId, String clientId, EntraAuthMethod authenticationMethod, String scopes, String username, String authorityHost)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Secret
    getAccessToken(com.google.jenkins.plugins.credentials.oauth.OAuth2ScopeRequirement requirement)
     
    EntraAuthMethod
    getAuthenticationMethod()
     
    String
    getAuthorityHost()
     
    String
    getClientId()
     
    List<String>
    getScopeList()
     
    String
    getScopes()
     
    String
    getTenantId()
     
    String
    getUsername()
     

    Methods inherited from class com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

    equals, getDescription, getId, hashCode

    Methods inherited from class com.cloudbees.plugins.credentials.BaseCredentials

    getDescriptor, getScope

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.cloudbees.plugins.credentials.Credentials

    forRun, getDescriptor, getScope

    Methods inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials

    getId

    Methods inherited from interface com.cloudbees.plugins.credentials.common.StandardCredentials

    getDescription

    Methods inherited from interface com.cloudbees.plugins.credentials.common.UsernameCredentials

    isUsernameSecret

  • Field Details

  • Constructor Details

    • EntraOAuthCredentials

      @DataBoundConstructor public EntraOAuthCredentials(@CheckForNull com.cloudbees.plugins.credentials.CredentialsScope scope, @CheckForNull String id, @CheckForNull String description, @CheckForNull String tenantId, @CheckForNull String clientId, @CheckForNull EntraAuthMethod authenticationMethod, @CheckForNull String scopes, @CheckForNull String username, @CheckForNull String authorityHost)

  • Method Details

    • getTenantId

      @NonNull public String getTenantId()

    • getClientId

      @NonNull public String getClientId()

    • getAuthenticationMethod

      @CheckForNull public EntraAuthMethod getAuthenticationMethod()

    • getScopes

      @NonNull public String getScopes()

    • getUsername

      @NonNull public String getUsername()
      Specified by:
      getUsername in interface com.cloudbees.plugins.credentials.common.UsernameCredentials

    • getAuthorityHost

      @NonNull public String getAuthorityHost()

    • getScopeList

      @NonNull public List<String> getScopeList()

    • getAccessToken

      public Secret getAccessToken(com.google.jenkins.plugins.credentials.oauth.OAuth2ScopeRequirement requirement)
      Specified by:
      getAccessToken in interface com.google.jenkins.plugins.credentials.oauth.OAuth2Credentials<com.google.jenkins.plugins.credentials.oauth.OAuth2ScopeRequirement>