providers/scim: add API endpoint to sync single user (#8486)

* add api

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* add UI

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* format

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

---------

Signed-off-by: Jens Langhammer <jens@goauthentik.io>
This commit is contained in:
Jens L.
2024-08-22 16:38:55 +02:00
committed by GitHub
parent e428e4cf5e
commit 46acab3b2e
11 changed files with 424 additions and 14 deletions

View File

@ -0,0 +1,131 @@
import "@goauthentik/admin/common/ak-flow-search/ak-flow-search-no-default";
import { DEFAULT_CONFIG } from "@goauthentik/common/api/config";
import { Form } from "@goauthentik/elements/forms/Form";
import "@goauthentik/elements/forms/HorizontalFormElement";
import "@goauthentik/elements/forms/SearchSelect";
import { msg } from "@lit/localize";
import { TemplateResult, html, nothing } from "lit";
import { customElement, property } from "lit/decorators.js";
import {
CoreApi,
CoreGroupsListRequest,
CoreUsersListRequest,
Group,
InitOverrideFunction,
SyncObjectModelEnum,
SyncObjectRequest,
SyncObjectResult,
User,
} from "@goauthentik/api";
@customElement("ak-sync-object-form")
export class SyncObjectForm extends Form<SyncObjectRequest> {
@property({ type: Number })
provider?: number;
@property()
model: SyncObjectModelEnum = SyncObjectModelEnum.UnknownDefaultOpenApi;
@property({ attribute: false })
result?: SyncObjectResult;
@property({ attribute: false })
sync: (
requestParameters: {
id: number;
syncObjectRequest: SyncObjectRequest;
},
initOverrides?: RequestInit | InitOverrideFunction,
) => Promise<SyncObjectResult> = (_, __) => {
return Promise.reject();
};
getSuccessMessage(): string {
return msg("Successfully triggered sync.");
}
async send(data: SyncObjectRequest): Promise<void> {
data.syncObjectModel = this.model;
this.result = await this.sync({
id: this.provider || 0,
syncObjectRequest: data,
});
}
renderSelectUser() {
return html`<ak-form-element-horizontal label=${msg("User")} name="syncObjectId">
<ak-search-select
.fetchObjects=${async (query?: string): Promise<User[]> => {
const args: CoreUsersListRequest = {
ordering: "username",
};
if (query !== undefined) {
args.search = query;
}
const users = await new CoreApi(DEFAULT_CONFIG).coreUsersList(args);
return users.results;
}}
.renderElement=${(user: User): string => {
return user.username;
}}
.renderDescription=${(user: User): TemplateResult => {
return html`${user.name}`;
}}
.value=${(user: User | undefined): number | undefined => {
return user?.pk;
}}
>
</ak-search-select>
</ak-form-element-horizontal>`;
}
renderSelectGroup() {
return html` <ak-form-element-horizontal label=${msg("Group")} name="syncObjectId">
<ak-search-select
.fetchObjects=${async (query?: string): Promise<Group[]> => {
const args: CoreGroupsListRequest = {
ordering: "name",
};
if (query !== undefined) {
args.search = query;
}
const groups = await new CoreApi(DEFAULT_CONFIG).coreGroupsList(args);
return groups.results;
}}
.renderElement=${(group: Group): string => {
return group.name;
}}
.value=${(group: Group | undefined): string | undefined => {
return group?.pk;
}}
>
</ak-search-select>
</ak-form-element-horizontal>`;
}
renderResult(): TemplateResult {
return html`<ak-form-element-horizontal label=${msg("Log messages")}>
<div class="pf-c-form__group-label">
<div class="c-form__horizontal-group">
<dl class="pf-c-description-list pf-m-horizontal">
<ak-log-viewer .logs=${this.result?.messages}></ak-log-viewer>
</dl>
</div>
</div>
</ak-form-element-horizontal> `;
}
renderForm() {
return html` ${this.model === SyncObjectModelEnum.User ? this.renderSelectUser() : nothing}
${this.model === SyncObjectModelEnum.Group ? this.renderSelectGroup() : nothing}
${this.result ? this.renderResult() : html``}`;
}
}
declare global {
interface HTMLElementTagNameMap {
"ak-sync-object-form": SyncObjectForm;
}
}