The `user-authentication-password-profile-info` object is the information object about the relationship between a [User Authentication Info](/docs/api/single-sign-on/user-authentication-infos) and a [Password Profile](/docs/api/single-sign-on/password-profiles) object.
openapi: 3.1.0
info:
version: 25.1126.6886238
x-version-timestamp: 2025-11-26 19:10:23+00:00
title: Addresses Introduction Account Addresses User Authentication Password Profile Infos API
description: 'The Addresses API allows you to organize account addresses. Addresses are a sub-resource of `account` resources, an account can have multiple addresses, such as home, work, and neighbour.
You can use an account address with either [client_credentials access token](/docs/api/authentication/create-an-access-token) or a combination of [implicit access token](/docs/api/authentication/create-an-access-token) and [Account Management authentication](/docs/api/accounts/post-v-2-account-members-tokens) token.
'
contact:
name: Elastic Path
url: https://www.elasticpath.com
email: support@elasticpath.com
license:
url: https://elasticpath.dev
name: MIT
servers:
- url: https://useast.api.elasticpath.com
description: US East
- url: https://euwest.api.elasticpath.com
description: EU West
security:
- BearerToken: []
tags:
- name: User Authentication Password Profile Infos
description: The `user-authentication-password-profile-info` object is the information object about the relationship between a [User Authentication Info](/docs/api/single-sign-on/user-authentication-infos) and a [Password Profile](/docs/api/single-sign-on/password-profiles) object.
paths:
/v2/authentication-realms/{realmId}/user-authentication-info/{userAuthInfoId}/user-authentication-password-profile-info:
get:
tags:
- User Authentication Password Profile Infos
summary: Get User Authentication Password Profile Info List
description: Retrieve a list of password profile information for a user.
operationId: get-v2-authentication-realms-realmId-user-authentication-info-userAuthInfoId-user-authentication-password-profile-info
parameters:
- name: realmId
in: path
description: The ID of the authentication realm.
required: true
schema:
type: string
format: uuid
- name: userAuthInfoId
in: path
description: The ID of the user authentication info.
required: true
schema:
type: string
format: uuid
- $ref: '#/components/parameters/page-limit'
- $ref: '#/components/parameters/page-offset'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/UserAuthenticationPasswordProfileInfoResponse'
links:
$ref: '#/components/schemas/PaginationLinks'
meta:
$ref: '#/components/schemas/PaginationMeta'
examples:
list_user_auth_password_profile_info:
summary: List of Password Profile Info for a user
value:
data:
- id: 9f8e7d6c-5b4a-3a2f-1e0d-c9b8a7f6e5d4
type: user_authentication_password_profile_info
username: uauppinamepestupdate@test.com
password_profile_id: a2f6d4c0-1d2b-4b3a-9e5a-2f4b1c7d8e9f
- id: 0c9b8a7f-6e5d-4c3b-2a1f-0e9d8c7b6a5f
type: user_authentication_password_profile_info
username: another.user@example.com
password_profile_id: b3e7f5a1-2c3d-4e4b-8f6a-3e5c2d8f9a0b
meta:
results:
total: 2
page:
limit: 25
offset: 0
links:
current: https://euwest.api.elasticpath.com/v2/authentication-realms/45928070-44a6-448b-8246-a85aa35320af/user-authentication-info/40c8ecfa-0d1a-43b2-8d62-2bbbb6c4207c/user-authentication-password-profile-info?page%5Boffset%5D=0&page%5Blimit%5D=25
first: https://euwest.api.elasticpath.com/v2/authentication-realms/45928070-44a6-448b-8246-a85aa35320af/user-authentication-info/40c8ecfa-0d1a-43b2-8d62-2bbbb6c4207c/user-authentication-password-profile-info?page%5Boffset%5D=0&page%5Blimit%5D=25
last: null
next: null
prev: null
'404':
$ref: '#/components/responses/NotFoundError'
'500':
$ref: '#/components/responses/InternalServerError'
post:
tags:
- User Authentication Password Profile Infos
summary: Create User Authentication Password Profile Info
description: Create password profile information for a specific user authentication info.
operationId: post-v2-authentication-realms-realmId-user-authentication-info-userAuthInfoId-user-authentication-password-profile-info
parameters:
- name: realmId
in: path
description: The ID of the authentication realm.
required: true
schema:
type: string
format: uuid
- name: userAuthInfoId
in: path
description: The ID of the user authentication info.
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/UserAuthenticationPasswordProfileInfoInput'
required:
- data
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/UserAuthenticationPasswordProfileInfoResponse'
links:
type: object
properties:
self:
description: A URL to the specific resource.
type: string
format: uri
'400':
$ref: '#/components/responses/BadRequestError'
'404':
$ref: '#/components/responses/NotFoundError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
? /v2/authentication-realms/{realmId}/user-authentication-info/{userAuthInfoId}/user-authentication-password-profile-info/{passwordProfileInfoId}
: get:
tags:
- User Authentication Password Profile Infos
summary: Get User Authentication Password Profile Info by ID
description: Retrieve specific password profile information by ID for a user.
operationId: get-v2-authentication-realms-realmId-user-authentication-info-userAuthInfoId-user-authentication-password-profile-info-passwordProfileInfoId
parameters:
- name: realmId
in: path
description: The ID of the authentication realm.
required: true
schema:
type: string
format: uuid
- name: userAuthInfoId
in: path
description: The ID of the user authentication info.
required: true
schema:
type: string
format: uuid
- name: passwordProfileInfoId
in: path
description: The ID of the password profile info.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/UserAuthenticationPasswordProfileInfoResponse'
links:
$ref: '#/components/schemas/SelfLink'
examples:
get_user_auth_password_profile_info:
summary: Password Profile Info for a user
value:
data:
id: 9f8e7d6c-5b4a-3a2f-1e0d-c9b8a7f6e5d4
type: user_authentication_password_profile_info
username: uauppinamepestupdate@test.com
password_profile_id: a2f6d4c0-1d2b-4b3a-9e5a-2f4b1c7d8e9f
links:
self: https://euwest.api.elasticpath.com/v2/authentication-realms/45928070-44a6-448b-8246-a85aa35320af/user-authentication-info/40c8ecfa-0d1a-43b2-8d62-2bbbb6c4207c/user-authentication-password-profile-info/9f8e7d6c-5b4a-3a2f-1e0d-c9b8a7f6e5d4
'400':
$ref: '#/components/responses/BadRequestError'
'404':
$ref: '#/components/responses/NotFoundError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
put:
tags:
- User Authentication Password Profile Infos
summary: Update User Authentication Password Profile Info
description: Update specific password profile information by ID for a user.
operationId: put-v2-authentication-realms-realmId-user-authentication-info-userAuthInfoId-user-authentication-password-profile-info-passwordProfileInfoId
parameters:
- name: realmId
in: path
description: The ID of the authentication realm.
required: true
schema:
type: string
format: uuid
- name: userAuthInfoId
in: path
description: The ID of the user authentication info.
required: true
schema:
type: string
format: uuid
- name: passwordProfileInfoId
in: path
description: The ID of the password profile info.
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/UserAuthenticationPasswordProfileInfoInput'
required:
- data
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/UserAuthenticationPasswordProfileInfoResponse'
links:
$ref: '#/components/schemas/SelfLink'
'400':
$ref: '#/components/responses/BadRequestError'
'404':
$ref: '#/components/responses/NotFoundError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
delete:
tags:
- User Authentication Password Profile Infos
summary: Delete User Authentication Password Profile Info
description: Delete specific password profile information by ID for a user.
operationId: delete-v2-authentication-realms-realmId-user-authentication-info-userAuthInfoId-user-authentication-password-profile-info-passwordProfileInfoId
parameters:
- name: realmId
in: path
description: The ID of the authentication realm.
required: true
schema:
type: string
format: uuid
- name: userAuthInfoId
in: path
description: The ID of the user authentication info.
required: true
schema:
type: string
format: uuid
- name: passwordProfileInfoId
in: path
description: The ID of the password profile info.
required: true
schema:
type: string
format: uuid
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/BadRequestError'
'404':
$ref: '#/components/responses/NotFoundError'
'422':
$ref: '#/components/responses/UnprocessableEntityError'
'500':
$ref: '#/components/responses/InternalServerError'
components:
schemas:
MetaTimestamps:
type: object
properties:
created_at:
description: The date the resource is created.
type: string
format: date-time
example: '2021-02-23T09:40:33.882Z'
updated_at:
description: The date the resource is updated.
type: string
format: date-time
example: '2021-02-23T09:40:33.882Z'
UUID:
type: string
description: The unique identifier.
format: uuid
example: deb6b25f-8451-4211-9a22-95610333df23
UserAuthenticationPasswordProfileInfoResponse:
allOf:
- $ref: '#/components/schemas/UserAuthenticationPasswordProfileInfo'
- type: object
properties:
id:
$ref: '#/components/schemas/UUID'
description: The unique identifier for User Authentication Password Profile Info.
meta:
$ref: '#/components/schemas/MetaTimestamps'
description: Additional information for this resource.
links:
type: object
properties:
self:
description: A URL to the specific resource.
type: string
format: uri
example: https://useast.api.elasticpath.com/v2/authentication-realms/deb6b25f-8451-4211-9a22-95610333df23/user-authentication-info/abc123/user-authentication-password-profile-info/def456
PaginationLinks:
type: object
properties:
current:
type: string
format: uri
description: The current page of data.
first:
type:
- string
- 'null'
format: uri
description: The first page of data.
last:
type:
- string
- 'null'
format: uri
description: The last page of data.
next:
type:
- string
- 'null'
format: uri
description: The next page of data.
prev:
type:
- string
- 'null'
format: uri
description: The previous page of data.
self:
type: string
format: uri
description: The current resource URL.
Error:
type: object
required:
- status
- title
properties:
title:
type: string
description: A brief summary of the error.
examples:
- Bad Request
status:
type: string
format: string
description: The HTTP response code of the error.
examples:
- '400'
detail:
type: string
description: Optional additional detail about the error.
examples:
- The field 'name' is required
SelfLink:
type: object
properties:
self:
description: A URL to the specific resource.
type: string
format: uri
UserAuthenticationPasswordProfileInfoInput:
allOf:
- $ref: '#/components/schemas/UserAuthenticationPasswordProfileInfo'
- type: object
properties:
password:
type: string
description: The password used to authenticate.
format: password
minLength: 8
example: P@ssw0rd123!
required:
- password
PaginationMeta:
type: object
properties:
page:
type: object
properties:
current:
type: integer
description: The current page number.
example: 1
limit:
type: integer
description: The number of items per page.
example: 25
offset:
type: integer
description: The number of items to offset by.
example: 0
total:
type: integer
description: The total number of pages.
example: 1
results:
type: object
properties:
total:
type: integer
description: The total number of results after applying filters, if any, or all results.
example: 1
ErrorResponse:
type: object
required:
- errors
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
links:
$ref: '#/components/schemas/SelfLink'
UserAuthenticationPasswordProfileInfo:
type: object
properties:
type:
type: string
description: Specifies the type of object. Set this value to `user_authentication_password_profile_info`.
const: user_authentication_password_profile_info
username:
type: string
description: The username used to authenticate.
example: uauppinamepestupdate@test.com
password_profile_id:
type: string
description: The ID of the associated password profile.
format: uuid
example: 767e6763-014e-4b6e-8a0e-59b863ab3262
required:
- type
- username
- password_profile_id
parameters:
page-limit:
name: page[limit]
in: query
description: The number of records per page.
required: false
schema:
type: integer
format: int64
minimum: 1
maximum: 100
default: 25
page-offset:
name: page[offset]
in: query
description: The number of records to offset the results by.
required: false
schema:
type: integer
format: int64
minimum: 0
default: 0
responses:
NotFoundError:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
not-found-error:
value:
errors:
- title: Not Found
status: '404'
detail: Resource not found
UnprocessableEntityError:
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
unprocessable-entity-error:
value:
errors:
- title: Unprocessable Entity
status: '422'
detail: Constraint violation
InternalServerError:
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
internal-server-error:
summary: Internal server error
value:
errors:
- title: Internal Server Error
status: '500'
detail: there was a problem processing your request
BadRequestError:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
bad-request-error:
value:
errors:
- title: Bad Request
status: '400'
detail: 'Validation failed: field ''Name'' on the ''min'' tag.'
securitySchemes:
BearerToken:
type: http
scheme: bearer