@acceleratxr/core_sdk / UserSecretService
Class: UserSecretService#
Hierarchy#
-
↳ UserSecretService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new UserSecretService(apiClient: ApiClient, config: Configuration): UserSecretService
Overrides ServiceBase.constructor
Defined in src/services/UserSecretService.ts:10
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: UserSecretService
Properties#
apiClient#
• Protected apiClient: ApiClient
Inherited from ServiceBase.apiClient
Defined in src/ServiceBase.ts:14
The API Client used when making requests to the API backend server.
config#
• Protected config: Configuration
Inherited from ServiceBase.config
Defined in src/ServiceBase.ts:19
The SDK configuration to use.
uuid#
▪ Static uuid: string = “53eb5d6f-6e61-493b-8e51-7c0d0061115f”
Defined in src/services/UserSecretService.ts:16
Methods#
configPasswords#
▸ configPasswords(): Promise<any>
Defined in src/services/UserSecretService.ts:21
Returns the configuration used for accepting user secrets of type password.
Returns: Promise<any>
count#
▸ count(userId: string, query?: any): Promise<number>
Defined in src/services/UserSecretService.ts:59
Returns the count of UserSecret objects for a given user.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
any |
Returns: Promise<number>
create#
▸ create(userId: string, obj: UserSecret): Promise<UserSecret | undefined>
Defined in src/services/UserSecretService.ts:46
Create a new user secret.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
Returns: Promise<UserSecret | undefined>
delete#
▸ delete(userId: string, id: string): Promise<void>
Defined in src/services/UserSecretService.ts:120
Deletes the UserSecret
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string |
Returns: Promise<void>
findAll#
▸ findAll(userId: string, query?: any): Promise<UserSecret[] | undefined>
Defined in src/services/UserSecretService.ts:33
Returns all secrets for a given user.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
any |
Returns: Promise<UserSecret[] | undefined>
findById#
▸ findById(userId: string, id: string): Promise<UserSecret | undefined>
Defined in src/services/UserSecretService.ts:92
Returns a single UserSecret for a specified user.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string |
Returns: Promise<UserSecret | undefined>
setPassword#
▸ setPassword(userId: string, obj: UserSecret): Promise<UserSecret | undefined>
Defined in src/services/UserSecretService.ts:79
Sets the password for the user with the given unique identifier.
Parameters:#
Name |
Type |
|---|---|
|
string |
|
Returns: Promise<UserSecret | undefined>
update#
▸ update(userId: string, id: string, obj: UserSecret): Promise<UserSecret | undefined>
Defined in src/services/UserSecretService.ts:106
Updates a single UserSecret
Parameters:#
Name |
Type |
|---|---|
|
string |
|
string |
|
Returns: Promise<UserSecret | undefined>