Validate AuthenticationProviderId and PasswordResetProviderId

[Chris-Codes-It]

Changes
POST /Users/{userId}/Policy returns BadRequest when PasswordResetProviderId is null or empty string

Issues
Issue 10417

[jellyfin-bot]

This pull request has merge conflicts. Please resolve the conflicts so the PR can be successfully reviewed and merged.

[crobibero]

Would adding [Required(AllowEmptyStrings = false)] to both AuthenticationProviderId and PasswordResetProviderId in UserPolicy provide the same experience?

[github-actions]

Changes in OpenAPI specification found. Expand to see details.

What's Changed

---

POST /Users/{userId}/Policy

Request:

Changed content type : application/json

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

Changed content type : text/json

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

Changed content type : application/*+json

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

GET /Users

Return Type:

Changed response : 200 OK

Users returned.

• Changed content type : application/json

Changed items (object):

Class UserDto.

openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

• Changed content type : application/json; profile="CamelCase"

Changed items (object):

Class UserDto.

openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

• Changed content type : application/json; profile="PascalCase"

Changed items (object):

Class UserDto.

openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

GET /Users/{userId}

Return Type:

Changed response : 200 OK

User returned.

• Changed content type : application/json

openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

• Changed content type : application/json; profile="CamelCase"

openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

• Changed content type : application/json; profile="PascalCase"

openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

POST /Users/{userId}

Request:

Changed content type : application/json

Updated UserDto :

• Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

Changed content type : text/json

Updated UserDto :

• Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

Changed content type : application/*+json

Updated UserDto :

• Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

GET /Users/Me

Return Type:

Changed response : 200 OK

User returned.

• Changed content type : application/json

openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

• Changed content type : application/json; profile="CamelCase"

openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

• Changed content type : application/json; profile="PascalCase"

openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

POST /Users/New

Return Type:

Changed response : 200 OK

User created.

• Changed content type : application/json

openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

• Changed content type : application/json; profile="CamelCase"

openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

• Changed content type : application/json; profile="PascalCase"

openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

GET /Users/Public

Return Type:

Changed response : 200 OK

Public users returned.

• Changed content type : application/json

Changed items (object):

Class UserDto.

openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

• Changed content type : application/json; profile="CamelCase"

Changed items (object):

Class UserDto.

openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

• Changed content type : application/json; profile="PascalCase"

Changed items (object):

Class UserDto.

openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

POST /Users/{userId}/Authenticate

Return Type:

Changed response : 200 OK

User authenticated.

• Changed content type : application/json

openapi-base openapi-changes.md openapi-head Changed property User (object)

Class UserDto.

Updated UserDto :
openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

• Changed content type : application/json; profile="CamelCase"

openapi-base openapi-changes.md openapi-head Changed property User (object)

Class UserDto.

Updated UserDto :
openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

• Changed content type : application/json; profile="PascalCase"

openapi-base openapi-changes.md openapi-head Changed property User (object)

Class UserDto.

Updated UserDto :
openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

POST /Users/AuthenticateByName

Return Type:

Changed response : 200 OK

User authenticated.

• Changed content type : application/json

openapi-base openapi-changes.md openapi-head Changed property User (object)

Class UserDto.

Updated UserDto :
openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

• Changed content type : application/json; profile="CamelCase"

openapi-base openapi-changes.md openapi-head Changed property User (object)

Class UserDto.

Updated UserDto :
openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

• Changed content type : application/json; profile="PascalCase"

openapi-base openapi-changes.md openapi-head Changed property User (object)

Class UserDto.

Updated UserDto :
openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

POST /Users/AuthenticateWithQuickConnect

Return Type:

Changed response : 200 OK

User authenticated.

• Changed content type : application/json

openapi-base openapi-changes.md openapi-head Changed property User (object)

Class UserDto.

Updated UserDto :
openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

• Changed content type : application/json; profile="CamelCase"

openapi-base openapi-changes.md openapi-head Changed property User (object)

Class UserDto.

Updated UserDto :
openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

• Changed content type : application/json; profile="PascalCase"

openapi-base openapi-changes.md openapi-head Changed property User (object)

Class UserDto.

Updated UserDto :
openapi-base openapi-changes.md openapi-head Changed property Policy (object)

Gets or sets the policy.

Updated UserPolicy :
New required properties:

• AuthenticationProviderId
• PasswordResetProviderId

[Chris-Codes-It]

Would adding [Required(AllowEmptyStrings = false)] to both AuthenticationProviderId and PasswordResetProviderId in UserPolicy provide the same experience?

@crobibero that's a fair comment; I did consider it however I didn't see any reference to ModelState.IsValid so I assumed no DataAnnotation binding had been wired-in. My bad. Have changed for both fields and updated the tests.

[crobibero]

https://learn.microsoft.com/en-us/aspnet/core/web-api/?view=aspnetcore-7.0#automatic-http-400-responses

The controller automatically validates models so the manual check isn't needed