Add new setUserTokenConfiguration.

Author: wparad

CHANGELOG.md

@@ -8,6 +8,7 @@ This is the changelog for [Authress SDK](readme.md).
 * [Breaking] `ServiceClientTokenProvider` is now a first-class Javascript Class, it cannot be used as a function.
 * [Breaking] `setToken` has been removed from the interface. To set a user token, pass in a function into the AuthressClient constructor.
 * [Fix] Remove passing the token in the request for token verification, it is completely unnecessary, and does not work for service clients in any scenario.
+* Add UserTokenConfiguration and setUserTokenConfiguration
 
 ## 2.3 ##
 * Require minimum Node version to be 16.

docs/UsersApi.md

@@ -5,6 +5,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**deleteUser**](UsersApi.md#deleteUser) | **DELETE** /v1/users/{userId} | Delete a user
 [**getUser**](UsersApi.md#getUser) | **GET** /v1/users/{userId} | Retrieve a user
+[**setUserTokenConfiguration**](UsersApi.md#setUserTokenConfiguration) | **PUT** /v1/users/{userId}/token-configuration | Set user token configuration
 [**getUsers**](UsersApi.md#getUsers) | **GET** /v1/users | List users
 [**linkTenantUser**](UsersApi.md#linkTenantUser) | **PATCH** /v1/tenants/{tenantId}/users | Link tenant user
 
@@ -101,6 +102,33 @@ Name | Type | Description  | Notes
 [**UserIdentityCollection**](UserIdentityCollection.md)
 
 
+## setUserTokenConfiguration
+
+> UserIdentity setUserTokenConfiguration(userId, tokenConfiguration)
+
+Set user token configuration.
+
+Sets the user authentication configuration. This endpoint contains properties that allow detailed control over tokens generated for the user.
+
+### Example
+
+```javascript
+import { AuthressClient, UserTokenConfiguration } from '@authress/sdk';
+
+const userId = "userId_example"; // UserId | The user identifier.
+const tokenConfiguration = new UserTokenConfiguration(); //  UserTokenConfiguration
+await new AuthressClient().users.setUserTokenConfiguration(userId, tokenConfiguration);
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **userId** | **String**| The user identifier. | 
+ **tokenConfiguration** | **UserTokenConfiguration** | Token configuration dedicated for the specific user. |
+
+
 ## linkTenantUser
 
 > linkTenantUser(tenantId, tenantUser)

index.d.ts

@@ -646,6 +646,46 @@ export interface UserIdentity {
    * @memberof UserIdentity
    */
   email?: string;
+
+  /**
+   *
+   * @type {UserTokenConfiguration}
+   * @memberof UserIdentity
+   */
+  tokenConfiguration?: UserTokenConfiguration;
+}
+
+/**
+ * @export
+ * @interface UserTokenConfiguration
+ */
+export interface UserTokenConfiguration {
+  /**
+   * Default fallback configuration for the claims inserted into the JWTs generated by Authress.
+   * @type {DefaultClaims}
+   * @memberof UserTokenConfiguration
+   */
+  defaultClaims?: DefaultClaims;
+}
+
+/**
+ * @export
+ * @interface DefaultClaims
+ */
+export interface DefaultClaims {
+  /**
+   * A map of claims to add to generated JWTs. These claims are used when explicitly not specified by Authress. Do not include any value specified by https://www.iana.org/assignments/jwt/jwt.xhtml as they will get overwritten. Must be smaller than 1024 Bytes.
+   * @type {Record<string, unknown>}
+   * @memberof DefaultClaims
+   */
+  defaultAccessTokenClaims?: Record<string, unknown>;
+
+  /**
+   * A map of claims to add to generated user identity tokens. These claims are used when explicitly not specified by Authress. Do not include any value specified by https://www.iana.org/assignments/jwt/jwt.xhtml as they will get overwritten. Must be smaller than 1024 Bytes.
+   * @type {Record<string, unknown>}
+   * @memberof DefaultClaims
+   */
+  defaultUserIdentityClaims?: Record<string, unknown>;
 }
 
 /**
@@ -931,10 +971,19 @@ export interface UsersApi {
   /**
    * Get an Authress user
    * @summary Retrieve a user with user data.
-   * @param {string} [userId] The user te get.
+   * @param {string} userId The user te get.
    * @throws {ArgumentRequiredError}
    */
   getUser(userId: string): Promise<Response<UserIdentity>>;
+
+  /**
+   * Set user token configuration
+   * @summary Sets the user authentication configuration. This endpoint contains properties that allow detailed control over tokens generated for the user.
+   * @param {string} userId The user identifier.
+   * @param {UserTokenConfiguration} tokenConfiguration The user token configuration, used to configure token properties.
+   * @throws {ArgumentRequiredError}
+   */
+  setUserTokenConfiguration(userId: string, tokenConfiguration: UserTokenConfiguration): Promise<Response<void>>;
 }
 
 /**

src/usersApi.js

@@ -14,6 +14,18 @@ class UsersApi {
     const response = await this.client.get(url);
     return response;
   }
+
+  async setUserTokenConfiguration(userId, tokenConfiguration) {
+    if (userId === null || userId === undefined) {
+      throw new ArgumentRequiredError('userId', 'Required parameter userId was null or undefined when calling setUserTokenConfiguration.');
+    }
+    if (tokenConfiguration === null || tokenConfiguration === undefined) {
+      throw new ArgumentRequiredError('tokenConfiguration', 'Required parameter tokenConfiguration was null or undefined when calling setUserTokenConfiguration.');
+    }
+    const url = `/v1/users/${encodeURIComponent(String(userId))}`;
+    const response = await this.client.put(url, tokenConfiguration);
+    return response;
+  }
 }
 
 module.exports = UsersApi;