Skip to content

Commit

Permalink
Update API Client
Browse files Browse the repository at this point in the history
#### 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`
  • Loading branch information
authentik-bot committed May 10, 2023
1 parent bb1815d commit 252164e
Show file tree
Hide file tree
Showing 12 changed files with 28 additions and 10 deletions.
7 changes: 7 additions & 0 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16557,6 +16557,7 @@ paths:

* `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.
Expand All @@ -16571,6 +16572,7 @@ paths:
- user_id
- user_upn
- user_username
- user_uuid
type: string
style: form
responses:
Expand Down Expand Up @@ -36095,6 +36097,7 @@ components:

* `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.
Expand Down Expand Up @@ -36220,6 +36223,7 @@ components:

* `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.
Expand Down Expand Up @@ -44545,6 +44549,7 @@ components:

* `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.
Expand Down Expand Up @@ -49716,12 +49721,14 @@ components:
description: |-
* `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.
enum:
- hashed_user_id
- user_id
- user_uuid
- user_username
- user_email
- user_upn
Expand Down
2 changes: 1 addition & 1 deletion api_providers.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/OAuth2Provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Name | Type | Description | Notes
**IncludeClaimsInIdToken** | Pointer to **bool** | Include User claims from scopes in the id_token, for applications that don't access the userinfo endpoint. | [optional]
**SigningKey** | Pointer to **NullableString** | Key used to sign the tokens. Only required when JWT Algorithm is set to RS256. | [optional]
**RedirectUris** | Pointer to **string** | Enter each URI on a new line. | [optional]
**SubMode** | Pointer to [**SubModeEnum**](SubModeEnum.md) | 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_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. | [optional]
**SubMode** | Pointer to [**SubModeEnum**](SubModeEnum.md) | 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. | [optional]
**IssuerMode** | Pointer to [**IssuerModeEnum**](IssuerModeEnum.md) | Configure how the issuer field of the ID Token should be filled. * `global` - Same identifier is used for all providers * `per_provider` - Each provider has a different issuer, based on the application slug. | [optional]
**JwksSources** | Pointer to **[]string** | | [optional]

Expand Down
2 changes: 1 addition & 1 deletion docs/OAuth2ProviderRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Name | Type | Description | Notes
**IncludeClaimsInIdToken** | Pointer to **bool** | Include User claims from scopes in the id_token, for applications that don't access the userinfo endpoint. | [optional]
**SigningKey** | Pointer to **NullableString** | Key used to sign the tokens. Only required when JWT Algorithm is set to RS256. | [optional]
**RedirectUris** | Pointer to **string** | Enter each URI on a new line. | [optional]
**SubMode** | Pointer to [**SubModeEnum**](SubModeEnum.md) | 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_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. | [optional]
**SubMode** | Pointer to [**SubModeEnum**](SubModeEnum.md) | 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. | [optional]
**IssuerMode** | Pointer to [**IssuerModeEnum**](IssuerModeEnum.md) | Configure how the issuer field of the ID Token should be filled. * `global` - Same identifier is used for all providers * `per_provider` - Each provider has a different issuer, based on the application slug. | [optional]
**JwksSources** | Pointer to **[]string** | | [optional]

Expand Down
2 changes: 1 addition & 1 deletion docs/PatchedOAuth2ProviderRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Name | Type | Description | Notes
**IncludeClaimsInIdToken** | Pointer to **bool** | Include User claims from scopes in the id_token, for applications that don't access the userinfo endpoint. | [optional]
**SigningKey** | Pointer to **NullableString** | Key used to sign the tokens. Only required when JWT Algorithm is set to RS256. | [optional]
**RedirectUris** | Pointer to **string** | Enter each URI on a new line. | [optional]
**SubMode** | Pointer to [**SubModeEnum**](SubModeEnum.md) | 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_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. | [optional]
**SubMode** | Pointer to [**SubModeEnum**](SubModeEnum.md) | 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. | [optional]
**IssuerMode** | Pointer to [**IssuerModeEnum**](IssuerModeEnum.md) | Configure how the issuer field of the ID Token should be filled. * `global` - Same identifier is used for all providers * `per_provider` - Each provider has a different issuer, based on the application slug. | [optional]
**JwksSources** | Pointer to **[]string** | | [optional]

Expand Down
4 changes: 2 additions & 2 deletions docs/ProvidersApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -1089,7 +1089,7 @@ func main() {
refreshTokenValidity := "refreshTokenValidity_example" // string | (optional)
search := "search_example" // string | A search term. (optional)
signingKey := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | (optional)
subMode := "subMode_example" // string | 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_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. (optional)
subMode := "subMode_example" // string | 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. (optional)

configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
Expand Down Expand Up @@ -1131,7 +1131,7 @@ Name | Type | Description | Notes
**refreshTokenValidity** | **string** | |
**search** | **string** | A search term. |
**signingKey** | **string** | |
**subMode** | **string** | 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_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. |
**subMode** | **string** | 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

Expand Down
2 changes: 2 additions & 0 deletions docs/SubModeEnum.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

* `USER_ID` (value: `"user_id"`)

* `USER_UUID` (value: `"user_uuid"`)

* `USER_USERNAME` (value: `"user_username"`)

* `USER_EMAIL` (value: `"user_email"`)
Expand Down
2 changes: 1 addition & 1 deletion model_o_auth2_provider.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion model_o_auth2_provider_request.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion model_patched_o_auth2_provider_request.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion model_sub_mode_enum.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 252164e

Please sign in to comment.