supabase / supabase-flutter / 28850807157

86%

push

github

feat(gotrue): add custom OAuth providers admin API with custom_claims_allowlist (#1519)

## What

Implements the custom OAuth/OIDC providers admin API in gotrue, exposed
as `client.auth.admin.customProviders`, mirroring the
`admin.customProviders` API in supabase-js (`/admin/custom-providers`).
This is distinct from the existing OAuth 2.1 server *clients* API
(`admin.oauth`).

Resolves
[SDK-1173](https://linear.app/supabase/issue/SDK-1173/parityauth-add-custom-claims-allowlist-to-custom-providers-admin-api).

The parity issue asked to add `custom_claims_allowlist` to the custom
providers admin types, but that API did not exist in the Flutter SDK at
all, so this adds the full surface including the field.

## Changes

- New `GoTrueAdminCustomProvidersApi` with `listProviders({type})`,
`createProvider`, `getProvider`, `updateProvider`, `deleteProvider`.
- Wired into `GoTrueAdminApi` as `admin.customProviders`.
- New types: `CustomProviderType`, `OIDCDiscoveryDocument`,
`CustomOAuthProvider`, `CreateCustomProviderParams`,
`UpdateCustomProviderParams`.
- All three provider types carry `customClaimsAllowlist` (serialized as
`custom_claims_allowlist`), an opt-in allowlist of raw identity provider
claim keys copied verbatim into the user's `custom_claims`. Optional,
absent by default.

## Usage

```dart
await supabase.auth.admin.customProviders.createProvider(
  CreateCustomProviderParams(
    providerType: CustomProviderType.oidc,
    identifier: 'custom:mycompany',
    name: 'My Company',
    clientId: '...',
    clientSecret: '...',
    customClaimsAllowlist: ['groups', 'org_id', 'mail'],
  ),
);
```

## Tests

- Unit tests for serialization/deserialization of
`custom_claims_allowlist` (present, absent, empty) across the
create/update/read types.
- Integration tests covering create/list/list-by-type/get/update/delete
against a live gotrue server.

Integration tests use OAuth2 providers (OIDC creation triggers a
server-side discovery-document fetch, which w... (continued)

128 of 129 new or added lines in 3 files covered. (99.22%)

4447 of 5148 relevant lines covered (86.38%)

4.0 hits per line