Skip to content

v3.2023041.12: Update API Client

Compare
Choose a tag to compare
@authentik-bot authentik-bot released this 10 May 16:09
· 212 commits to main since this release

What's Changed


GET /providers/oauth2/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property sub_mode (string)

      • hashed_user_id - Based on the Hashed User ID
      • user_id - Based on user ID
      • user_uuid - Based on user UUID
      • user_username - Based on the username
      • user_email - Based on the User's Email. This is recommended over the UPN method.
      • user_upn - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains.

      Added enum value:

      • user_uuid
PUT /providers/oauth2/{id}/
Request:

Changed content type : application/json

  • Changed property sub_mode (string)

    • hashed_user_id - Based on the Hashed User ID
    • user_id - Based on user ID
    • user_uuid - Based on user UUID
    • user_username - Based on the username
    • user_email - Based on the User's Email. This is recommended over the UPN method.
    • user_upn - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains.

    Added enum value:

    • user_uuid
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property sub_mode (string)

      • hashed_user_id - Based on the Hashed User ID
      • user_id - Based on user ID
      • user_uuid - Based on user UUID
      • user_username - Based on the username
      • user_email - Based on the User's Email. This is recommended over the UPN method.
      • user_upn - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains.

      Added enum value:

      • user_uuid
PATCH /providers/oauth2/{id}/
Request:

Changed content type : application/json

  • Changed property sub_mode (string)

    • hashed_user_id - Based on the Hashed User ID
    • user_id - Based on user ID
    • user_uuid - Based on user UUID
    • user_username - Based on the username
    • user_email - Based on the User's Email. This is recommended over the UPN method.
    • user_upn - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains.

    Added enum value:

    • user_uuid
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property sub_mode (string)

      • hashed_user_id - Based on the Hashed User ID
      • user_id - Based on user ID
      • user_uuid - Based on user UUID
      • user_username - Based on the username
      • user_email - Based on the User's Email. This is recommended over the UPN method.
      • user_upn - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains.

      Added enum value:

      • user_uuid
POST /providers/oauth2/
Request:

Changed content type : application/json

  • Changed property sub_mode (string)

    • hashed_user_id - Based on the Hashed User ID
    • user_id - Based on user ID
    • user_uuid - Based on user UUID
    • user_username - Based on the username
    • user_email - Based on the User's Email. This is recommended over the UPN method.
    • user_upn - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains.

    Added enum value:

    • user_uuid
Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property sub_mode (string)

      • hashed_user_id - Based on the Hashed User ID
      • user_id - Based on user ID
      • user_uuid - Based on user UUID
      • user_username - Based on the username
      • user_email - Based on the User's Email. This is recommended over the UPN method.
      • user_upn - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains.

      Added enum value:

      • user_uuid
GET /providers/oauth2/
Parameters:

Changed: sub_mode in query

Configure what data should be used as unique User Identifier. For most cases, the default should be fine.

  • hashed_user_id - Based on the Hashed User ID
  • user_id - Based on user ID
  • user_uuid - Based on user UUID
  • user_username - Based on the username
  • user_email - Based on the User's Email. This is recommended over the UPN method.
  • user_upn - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains.
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > OAuth2Provider Serializer

      • Changed property sub_mode (string)

        • hashed_user_id - Based on the Hashed User ID
        • user_id - Based on user ID
        • user_uuid - Based on user UUID
        • user_username - Based on the username
        • user_email - Based on the User's Email. This is recommended over the UPN method.
        • user_upn - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains.

        Added enum value:

        • user_uuid
GET /oauth2/access_tokens/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider (object)

      OAuth2Provider Serializer

      • Changed property sub_mode (string)

        • hashed_user_id - Based on the Hashed User ID
        • user_id - Based on user ID
        • user_uuid - Based on user UUID
        • user_username - Based on the username
        • user_email - Based on the User's Email. This is recommended over the UPN method.
        • user_upn - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains.

        Added enum value:

        • user_uuid
GET /oauth2/authorization_codes/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider (object)

      OAuth2Provider Serializer

      • Changed property sub_mode (string)

        • hashed_user_id - Based on the Hashed User ID
        • user_id - Based on user ID
        • user_uuid - Based on user UUID
        • user_username - Based on the username
        • user_email - Based on the User's Email. This is recommended over the UPN method.
        • user_upn - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains.

        Added enum value:

        • user_uuid
GET /oauth2/refresh_tokens/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider (object)

      OAuth2Provider Serializer

      • Changed property sub_mode (string)

        • hashed_user_id - Based on the Hashed User ID
        • user_id - Based on user ID
        • user_uuid - Based on user UUID
        • user_username - Based on the username
        • user_email - Based on the User's Email. This is recommended over the UPN method.
        • user_upn - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains.

        Added enum value:

        • user_uuid
GET /oauth2/access_tokens/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > Serializer for BaseGrantModel and RefreshToken

      • Changed property provider (object)

        OAuth2Provider Serializer

        • Changed property sub_mode (string)

          • hashed_user_id - Based on the Hashed User ID
          • user_id - Based on user ID
          • user_uuid - Based on user UUID
          • user_username - Based on the username
          • user_email - Based on the User's Email. This is recommended over the UPN method.
          • user_upn - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains.

          Added enum value:

          • user_uuid
GET /oauth2/authorization_codes/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > Serializer for BaseGrantModel and ExpiringBaseGrant

      • Changed property provider (object)

        OAuth2Provider Serializer

        • Changed property sub_mode (string)

          • hashed_user_id - Based on the Hashed User ID
          • user_id - Based on user ID
          • user_uuid - Based on user UUID
          • user_username - Based on the username
          • user_email - Based on the User's Email. This is recommended over the UPN method.
          • user_upn - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains.

          Added enum value:

          • user_uuid
GET /oauth2/refresh_tokens/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > Serializer for BaseGrantModel and RefreshToken

      • Changed property provider (object)

        OAuth2Provider Serializer

        • Changed property sub_mode (string)

          • hashed_user_id - Based on the Hashed User ID
          • user_id - Based on user ID
          • user_uuid - Based on user UUID
          • user_username - Based on the username
          • user_email - Based on the User's Email. This is recommended over the UPN method.
          • user_upn - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains.

          Added enum value:

          • user_uuid