Package com.symphony.bdk.gen.api

Class AuthenticationApi

java.lang.Object
com.symphony.bdk.gen.api.AuthenticationApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-03-26T16:14:56.195647482Z[Etc/UTC]") public class AuthenticationApi extends Object

  • Constructor Details

    • AuthenticationApi

      public AuthenticationApi(com.symphony.bdk.http.api.ApiClient apiClient)

  • Method Details

    • getApiClient

      public com.symphony.bdk.http.api.ApiClient getApiClient()
      Get the API cilent
      Returns:
      API client

    • setApiClient

      public void setApiClient(com.symphony.bdk.http.api.ApiClient apiClient)
      Set the API cilent
      Parameters:
      apiClient - an instance of API client

    • idmKeysGet

      public Jwks idmKeysGet() throws com.symphony.bdk.http.api.ApiException
      Returns the Common Access Token (JWT) public keys as a JWKS. This is a public endpoint, no authentication is required. The JWKS can be used to verify JWT issued by the idm/tokens endpoint. Since SBE 20.14.
      Returns:
      Jwks
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • idmKeysGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<Jwks> idmKeysGetWithHttpInfo() throws com.symphony.bdk.http.api.ApiException
      Returns the Common Access Token (JWT) public keys as a JWKS. This is a public endpoint, no authentication is required. The JWKS can be used to verify JWT issued by the idm/tokens endpoint. Since SBE 20.14.
      Returns:
      ApiResponse<Jwks>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • idmTokensPost

      public JwtToken idmTokensPost(String sessionToken, String scope) throws com.symphony.bdk.http.api.ApiException
      Returns a valid OAuth2 access token from a given session token to be used for authentication
      Parameters:
      sessionToken - User session authentication token (required)
      scope - Optional field used to get access with specific entitlements, use space separated list to define more that one (optional)
      Returns:
      JwtToken
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • idmTokensPostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<JwtToken> idmTokensPostWithHttpInfo(String sessionToken, String scope) throws com.symphony.bdk.http.api.ApiException
      Returns a valid OAuth2 access token from a given session token to be used for authentication
      Parameters:
      sessionToken - User session authentication token (required)
      scope - Optional field used to get access with specific entitlements, use space separated list to define more that one (optional)
      Returns:
      ApiResponse<JwtToken>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • pubkeyAppAuthenticatePost

      public Token pubkeyAppAuthenticatePost(AuthenticateRequest authenticateRequest) throws com.symphony.bdk.http.api.ApiException
      Authenticate an App with public key Based on an authentication request token signed by the application's RSA private key, authenticate the API caller and return a session token. A HTTP 401 Unauthorized error is returned on errors during authentication (e.g. invalid app, malformed authentication token, app's public key not imported in the pod, invalid token signature etc.).
      Parameters:
      authenticateRequest - (required)
      Returns:
      Token
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • pubkeyAppAuthenticatePostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<Token> pubkeyAppAuthenticatePostWithHttpInfo(AuthenticateRequest authenticateRequest) throws com.symphony.bdk.http.api.ApiException
      Authenticate an App with public key Based on an authentication request token signed by the application's RSA private key, authenticate the API caller and return a session token. A HTTP 401 Unauthorized error is returned on errors during authentication (e.g. invalid app, malformed authentication token, app's public key not imported in the pod, invalid token signature etc.).
      Parameters:
      authenticateRequest - (required)
      Returns:
      ApiResponse<Token>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • pubkeyAppUserUserIdAuthenticatePost

      public Token pubkeyAppUserUserIdAuthenticatePost(String sessionToken, Long userId) throws com.symphony.bdk.http.api.ApiException
      Authenticate an application in a delegated context to act on behalf of a user
      Parameters:
      sessionToken - App Session authentication token. (required)
      userId - the user ID (required)
      Returns:
      Token
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • pubkeyAppUserUserIdAuthenticatePostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<Token> pubkeyAppUserUserIdAuthenticatePostWithHttpInfo(String sessionToken, Long userId) throws com.symphony.bdk.http.api.ApiException
      Authenticate an application in a delegated context to act on behalf of a user
      Parameters:
      sessionToken - App Session authentication token. (required)
      userId - the user ID (required)
      Returns:
      ApiResponse<Token>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • pubkeyAppUsernameUsernameAuthenticatePost

      public Token pubkeyAppUsernameUsernameAuthenticatePost(String sessionToken, String username) throws com.symphony.bdk.http.api.ApiException
      Authenticate an application in a delegated context to act on behalf of a user
      Parameters:
      sessionToken - App Session authentication token. (required)
      username - the username (required)
      Returns:
      Token
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • pubkeyAppUsernameUsernameAuthenticatePostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<Token> pubkeyAppUsernameUsernameAuthenticatePostWithHttpInfo(String sessionToken, String username) throws com.symphony.bdk.http.api.ApiException
      Authenticate an application in a delegated context to act on behalf of a user
      Parameters:
      sessionToken - App Session authentication token. (required)
      username - the username (required)
      Returns:
      ApiResponse<Token>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • pubkeyAuthenticatePost

      public Token pubkeyAuthenticatePost(AuthenticateRequest authenticateRequest) throws com.symphony.bdk.http.api.ApiException
      Authenticate with public key Based on an authentication request token signed by the caller's RSA private key, authenticate the API caller and return a session token. A HTTP 401 Unauthorized error is returned on errors during authentication (e.g. invalid user, malformed authentication token, user's public key not imported in the pod, invalid token signature etc.).
      Parameters:
      authenticateRequest - (required)
      Returns:
      Token
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • pubkeyAuthenticatePostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<Token> pubkeyAuthenticatePostWithHttpInfo(AuthenticateRequest authenticateRequest) throws com.symphony.bdk.http.api.ApiException
      Authenticate with public key Based on an authentication request token signed by the caller's RSA private key, authenticate the API caller and return a session token. A HTTP 401 Unauthorized error is returned on errors during authentication (e.g. invalid user, malformed authentication token, user's public key not imported in the pod, invalid token signature etc.).
      Parameters:
      authenticateRequest - (required)
      Returns:
      ApiResponse<Token>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1PubkeyAppAuthenticateExtensionAppPost

      public ExtensionAppTokens v1PubkeyAppAuthenticateExtensionAppPost(AuthenticateExtensionAppRequest authenticateRequest) throws com.symphony.bdk.http.api.ApiException
      Authenticate extension app with public key Based on an authentication request token signed by the caller's RSA private key, authenticate the API caller and return a session token. A HTTP 401 Unauthorized error is returned on errors during authentication (e.g. invalid user, malformed authentication token, user's public key not imported in the pod, invalid token signature etc.).
      Parameters:
      authenticateRequest - (required)
      Returns:
      ExtensionAppTokens
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1PubkeyAppAuthenticateExtensionAppPostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<ExtensionAppTokens> v1PubkeyAppAuthenticateExtensionAppPostWithHttpInfo(AuthenticateExtensionAppRequest authenticateRequest) throws com.symphony.bdk.http.api.ApiException
      Authenticate extension app with public key Based on an authentication request token signed by the caller's RSA private key, authenticate the API caller and return a session token. A HTTP 401 Unauthorized error is returned on errors during authentication (e.g. invalid user, malformed authentication token, user's public key not imported in the pod, invalid token signature etc.).
      Parameters:
      authenticateRequest - (required)
      Returns:
      ApiResponse<ExtensionAppTokens>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call