com.siemens.mindsphere.sdk.agentmanagement.apiclient

Class RegistrationClient

Object

MindsphereAPIClient

RegistrationClient

public class RegistrationClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegistrationClient.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
RegistrationClient(RegistrationClient.ClientBuilder builder)

Method Summary

Modifier and Type	Method and Description
static RegistrationClient.ClientBuilder	builder()
ClientIdentifier	onBoardAgent(String initialAccessToken, Object keys) Registers client based on given security profile.
ClientIdentifier	onBoardAgentWithRSAProfile(String initialAccessToken, Keys rsaPublicKey) Registers client with RSA security profile.
ClientIdentifier	onBoardAgentWithSharedSecretProfile(String initialAccessToken) Registers client with SHARED_SECRET security profile.
ClientIdentifier	rotateKeysForRSA(String registrationAccessToken, String clientId, RotationKeys keys) Updates clients information.
ClientIdentifier	rotateKeysForSharedSecret(String registrationAccessToken, String clientId) Update client information.

Methods inherited from class Object

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

Constructor Detail

RegistrationClient

public RegistrationClient(RegistrationClient.ClientBuilder builder)

Method Detail

builder

public static RegistrationClient.ClientBuilder builder()

rotateKeysForRSA

public ClientIdentifier rotateKeysForRSA(String registrationAccessToken,
                                         String clientId,
                                         RotationKeys keys)
                                  throws MindsphereException

Updates clients information.

200 - OK

400 - Bad Request

401 - Unauthorized

Parameters:

registrationAccessToken - Registration Access Token value with Bearer authentication scheme. e.g :Bearer eyJh...

clientId - Client identifier to update information.

keys - The client's key in JWKS for security profile RSA. If security profile is SHARED_SECRET there is only client_id in the JSON.

Returns:

ClientIdentifier

Throws:

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

rotateKeysForSharedSecret

public ClientIdentifier rotateKeysForSharedSecret(String registrationAccessToken,
                                                  String clientId)
                                           throws MindsphereException

Update client information. Updates clients information.

200 - OK

400 - Bad Request

401 - Unauthorized

Parameters:

registrationAccessToken - Registration Access Token value with Bearer authentication scheme. e.g :Bearer eyJh...

clientId - Client identifier to update information.

Returns:

ClientIdentifier

Throws:

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

onBoardAgent

public ClientIdentifier onBoardAgent(String initialAccessToken,
                                     Object keys)
                              throws MindsphereException

Registers client based on given security profile. If profile is "SHARED_SECRET" , empty HashMap needs to be sent for "keys". If profile is "RSA" , RSA Public keys needs to be sent for "keys".

201 - Created

400 - Bad Request

401 - Unauthorized

Parameters:

initialAccessToken - Initial Access Token value with Bearer authentication scheme. e.g :Bearer eyJh...

keys - The client's key in JWKS for security profile RSA. If security profile is SHARED_SECRET the value is empty JSON.

Returns:

ClientIdentifier

Throws:

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

onBoardAgentWithSharedSecretProfile

public ClientIdentifier onBoardAgentWithSharedSecretProfile(String initialAccessToken)
                                                     throws MindsphereException

Registers client with SHARED_SECRET security profile.

201 - Created

400 - Bad Request

401 - Unauthorized

Parameters:

initialAccessToken - Initial Access Token value with Bearer authentication scheme. e.g :Bearer eyJh...

Returns:

ClientIdentifier

Throws:

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

onBoardAgentWithRSAProfile

public ClientIdentifier onBoardAgentWithRSAProfile(String initialAccessToken,
                                                   Keys rsaPublicKey)
                                            throws MindsphereException

Registers client with RSA security profile.

201 - Created

400 - Bad Request

401 - Unauthorized

Parameters:

initialAccessToken - Initial Access Token value with Bearer authentication scheme. e.g :Bearer eyJh...

rsaPublicKey - The client's key in JWKS for security profile RSA. If security profile is SHARED_SECRET the value is empty JSON.

Returns:

ClientIdentifier

Throws:

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