com.siemens.mindsphere.sdk.agentmanagement.apiclient

Class TokenOperationsClient

Object

MindsphereAPIClient

TokenOperationsClient

public class TokenOperationsClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TokenOperationsClient.ClientBuilder

Nested classes/interfaces inherited from class MindsphereAPIClient

MindsphereAPIClient.Builder<T extends MindsphereAPIClient.Builder<T>>

Field Summary

Fields inherited from class MindsphereAPIClient

credentials, restClientConfig, restTemplate

Constructor Summary

Constructors

Constructor and Description
TokenOperationsClient(TokenOperationsClient.ClientBuilder builder)

Method Summary

Modifier and Type	Method and Description
static TokenOperationsClient.ClientBuilder	builder()
TokenKey	oauthTokenKeyGet(String ifNoneMatch) Returns the JWT signing key currently employed by Agent IAM Provides current RSA public key of AgentIAM.
TokenKeys	oauthTokenKeysGet() Returns the JWT signing keys currently and previously employed by Agent IAM Returns all valid JWT signing keys which can be used to verify JWTs (Bearer, RAT, IAT) issued by AgentIAM.
AccessToken	oauthTokenPost(String grantType, String clientAssertionType, String clientAssertion) Grant an Access Token Grants an Access Token.

Methods inherited from class Object

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

Constructor Detail

TokenOperationsClient

public TokenOperationsClient(TokenOperationsClient.ClientBuilder builder)

Method Detail

builder

public static TokenOperationsClient.ClientBuilder builder()

oauthTokenKeyGet

public TokenKey oauthTokenKeyGet(String ifNoneMatch)
                          throws MindsphereException

Returns the JWT signing key currently employed by Agent IAM Provides current RSA public key of AgentIAM. AgentIAM uses corresponding RSA private key to sign access tokens, RATs and IATs.

200 - OK

304 - Not Modified

500 - unexpected error

0 - Other error with any status code and response body format.

Parameters:

ifNoneMatch - If-None-Match Parameter.

Returns:

TokenKey

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

oauthTokenKeysGet

public TokenKeys oauthTokenKeysGet()
                            throws MindsphereException

Returns the JWT signing keys currently and previously employed by Agent IAM Returns all valid JWT signing keys which can be used to verify JWTs (Bearer, RAT, IAT) issued by AgentIAM. The first key corresponds to the currently employed one, all others have been used in the past. The \"kid\" JWT claim allows to identify the signing key to be used. This endpoint conforms with RFC 7517 and RFC 7518 and endpoints output can be parsed as stated in the above mentioned RFCs.

200 - OK

500 - unexpected error

0 - Other error with any status code and response body format.

Returns:

TokenKeys

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

oauthTokenPost

public AccessToken oauthTokenPost(String grantType,
                                  String clientAssertionType,
                                  String clientAssertion)
                           throws MindsphereException

Grant an Access Token Grants an Access Token.

200 - OK

400 - Bad Request

500 - unexpected error

0 - Other error with any status code and response body format.

Parameters:

grantType - The type of authentication being used to obtain the token, only client_credentials is supported.

clientAssertionType - Defines the assertion type, only urn:ietf:params:oauth:client-assertion-type:jwt-bearer is supported.

clientAssertion - Token is signed (by the client) with keys (which is provided at '/register' | '/register/<client_id>' endpoint) or client_secret (which is provided by '/register' | '/register/<client_id>' endpoint) in jwt format.

Returns:

AccessToken

Throws:

MindsphereException - if an error occurs while attempting to invoke the API