Operations addressed under /users — 8 operations.
aurax-bnpl-bff-redirect-exchange-user-token
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target bnpl-management-service-exchange-user-token; this entry declares none of its own.
Response body, read from the service source
The route declares its response as ExchangeUserTokenDto.
| Field | Declared type | Nullable |
|---|---|---|
AccessToken | string | no |
ExpiresIn | int | no |
RefreshToken | string | no |
RefreshExpiresIn | int | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_BNPL_1 | 400 | IP_ADDRESS_NOT_ALLOWED | Access denied. Your IP address is not authorized to use this API. |
ERR_BNPL_2 | 400 | USER_UPDATE | not published in this snapshot |
ERR_BNPL_3 | 400 | USER_NOT_FOUND | USER_NOT_FOUND |
aurax-bnpl-bff-redirect-exchange-user-token › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bnpl-bff-service-dynamic-generate-user-password
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target generate-user-password; this entry declares none of its own.
Response body, read from the service source
The route declares its response as GeneratePasswordResponse.
| Field | Declared type | Nullable |
|---|---|---|
Password | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_AUT_1 | 400 | INVALID_PASS_POLICY |
ERR_CORE_165 | 400 | PASSWORD_POLICY_IS_NOT_FOUND_THIS_USER_TYPE |
aurax-bnpl-bff-service-dynamic-generate-user-password › Request Body
userTypeaurax-bnpl-bff-service-dynamic-generate-user-password › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
aurax-bnpl-bff-redirect-get-user-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-user-list; this entry declares none of its own.
Declared as Route-bound but absent from the route template, so not sendable: realm.
query Parameters
briefRepresentationexactfirstmaxorderByorderSortpageIndexpageSizeqsearchusernameHeaders
Authorizationaurax-bnpl-bff-redirect-get-user-list › Responses
Success. Returns a page of records: the collection under data, with total carrying the unpaged count.
Response records carried by this page.
totalTotal matching records, ignoring paging.
aurax-bnpl-bff-service-redirect-create-user
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-bnpl-bff-service-redirect-create-user service definition through POST /users.
Request and response fields are declared on the routing target create-user-bpm; this entry declares none of its own.
INCOMPLETE CONTRACT. The catalog declares 2 request field(s), 2 of them Mandatory (resourceName, resourceScopes) that this document could NOT place and does not show: the catalog parents this field to a row belonging to a DIFFERENT service, so it is a child of a node that is not part of this contract. So the properties and any required array below are a SUBSET of what the catalog declares, not the whole of it. They are dropped rather than re-attached because placing them would mean guessing which node they belong under, and this document does not guess. See x-aura-incomplete-contract for the field names.
Headers
Authorizationaurax-bnpl-bff-service-redirect-create-user › Request Body
firstNamelastNameuserNameattributesbnplCustomerGroupIdemailgeneratePasswordPwfrealmaurax-bnpl-bff-service-redirect-create-user › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
keycloakUserIduserPasswordaurax-bnpl-bff-get-current-user
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as UserDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Username | string | no |
OrganizationId | Guid? | yes |
OrganizationCode | string | no |
FullName | string | no |
FirstName | string | no |
LastName | string | no |
PreferredUsername | string | no |
IsServiceUser | bool? | yes |
CustomerId | Guid? | yes |
Theme | string | no |
AuthTime | long? | yes |
Locale | string | no |
GroupMemberships | IEnumerable<string> (collection) | no |
Member names are the service's declaration names.
aurax-bnpl-bff-get-current-user › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bnpl-bff-service-redirect-forget-password-send-otp
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-bnpl-bff-service-redirect-forget-password-send-otp service definition through POST /users/forget-password.
Request and response fields are declared on the routing target send-otp-forget-password; this entry declares none of its own.
Response body, read from the service source
The route declares its response as SendotpForgetPasswordResponse.
| Field | Declared type | Nullable |
|---|---|---|
Username | string | no |
EndDate | DateTime? | yes |
TransactionId | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status |
|---|---|
ERR_BPMCUS_17 | 400 |
ERR_CORE_161 | 400 |
aurax-bnpl-bff-service-redirect-forget-password-send-otp › Request Body
userIdentifieraurax-bnpl-bff-service-redirect-forget-password-send-otp › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
aurax-bnpl-bff-service-redirect-forget-password-verify-otp-and-reset-password
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-bnpl-bff-service-redirect-forget-password-verify-otp-and-reset-password service definition through POST /users/forget-password-verify.
Request and response fields are declared on the routing target forget-password-verify-otp-and-reset-password; this entry declares none of its own.
aurax-bnpl-bff-service-redirect-forget-password-verify-otp-and-reset-password › Request Body
oneTimePasswordtransactionIdusernameaurax-bnpl-bff-service-redirect-forget-password-verify-otp-and-reset-password › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bnpl-bff-service-dynamic-change-user-password
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target change-user-password-bpm; this entry declares none of its own.
aurax-bnpl-bff-service-dynamic-change-user-password › Request Body
newPasswordoldPasswordusernamevalidityDurationaurax-bnpl-bff-service-dynamic-change-user-password › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.