providers_scim_sync_object_create

POST 
/api/v3//providers/scim/:id/sync/object/

Sync/Re-sync a single user/group object

Request

Path Parameters

id integerrequired

A unique integer value identifying this SCIM Provider.

application/json

Bodyrequired

sync_object_modelSyncObjectModelEnum (string)required
Possible values: [authentik.core.models.User, authentik.core.models.Group]
sync_object_idstringrequired
Possible values: non-empty
override_dry_runboolean
Default value: false

Responses

200

application/json

Schema

Schema

messages object[]required
Array [
timestampdate-timerequired
log_levelLogLevelEnum (string)required
Possible values: [critical, exception, error, warn, warning, info, debug, notset]
loggerstringrequired
eventstringrequired
attributes objectrequired
property name*any
]

Example (auto)

{
  "messages": [
    {
      "timestamp": "2024-07-29T15:51:28.071Z",
      "log_level": "critical",
      "logger": "string",
      "event": "string",
      "attributes": {}
    }
  ]
}

400

application/json

Schema

Schema

non_field_errorsstring[]

codestring

property name*any

Validation Error

Example (auto)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detailstringrequired
codestring

Example (auto)

{
  "detail": "string",
  "code": "string"
}

Authorization: http

name: authentiktype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "/api/v3/providers/scim/:id/sync/object/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"sync_object_model\": \"authentik.core.models.User\",\n  \"sync_object_id\": \"string\",\n  \"override_dry_run\": false\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

id — pathrequired

Body required

{
  "sync_object_model": "authentik.core.models.User",
  "sync_object_id": "string",
  "override_dry_run": false
}