registerWithJwt

@POST(value = jwtRegister)
abstract suspend fun registerWithJwt(@Body() jwtUserRequestDto: JwtUserRequestDto): Response<RegisterUserResponseDto>
Content copied to clipboard

Register a user using JWT This API call allows you to register a new user using a JSON Web Token. &lt;br/&gt;&lt;br/&gt;Your client account must be configured to allow JWT (please reach out to the Sensibill Support Team). The API supports JWS and JWE as JWT implementations. &lt;br/&gt;&lt;br/&gt;JWS currently supports RSA and ECDSA signing algorithms (RS256, RS384, RS512, ES256, ES384, ES512). Public keys for signature verification should be made available through a publicly accessible URL. JWS header must have &#39;&#39;alg&#39;&#39; and &#39;&#39;kid&#39;&#39; parameters and the payload must have at least &#39;&#39;sub&#39;&#39; and &#39;&#39;iat&#39;&#39; claims. The &#39;&#39;sub&#39;&#39; claim will be used as a user access ID for the user being created. If there is a desire to use another claim for those purposes then it can be configured during the client account setup. JWS implementation also supports &#39;&#39;exp&#39;&#39;, &#39;&#39;aud&#39;&#39;, &#39;&#39;iss&#39;&#39; and &#39;&#39;scp&#39;&#39; claims. If there is a need to validate those claims they should be configured as part of the client account setup. &lt;br/&gt;&lt;br/&gt;JWE currently supports RSAES OAEP using default parameters (&#39;&#39;alg&#39;&#39;: RSA-OAEP) for encrypting the Content Encryption Key (CEK) and AES GCM using 256-bit key (&#39;&#39;enc&#39;&#39;: &#39;&#39;A256GCM&#39;&#39;) for encrypting the content. Please reach out to the Sensibill Support Team to receive Sensibill’s public key to be used for JWT encryption. JWE’s content is expected to be a JWS conforming to the JWS requirements mentioned earlier. Responses:

  • 200: Success. The new user was successfully registered.

  • 400: Bad Request. This will occur if you omit a required parameter, if you provide an invalid value for a required parameter, or if the JSON Web Token is either incomplete or cannot be verified. This status code will also occur if you try to register the same user more than once. In that case, an InvalidParametersError response will be returned containing the error 'Access ID is already registered.'

Return

RegisterUserResponseDto

Parameters

jwtUserRequestDto

Register a user