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

Body

required

sync_object_model SyncObjectModelEnum (string)required

Possible values: [authentik.core.models.User, authentik.core.models.Group]

sync_object_id stringrequired

Possible values: non-empty

Responses

200

application/json

Schema

Schema

messages

object[]

required

Array [

timestamp date-timerequired

log_level LogLevelEnum (string)required

Possible values: [critical, exception, error, warn, warning, info, debug, notset]

logger stringrequired

event stringrequired

attributes

object

required

property name* any

]

Example (from schema)

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

400

application/json

Schema

Schema

non_field_errors string[]
code string
property name* any

Validation Error

Example (from schema)

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

403

application/json

Schema

Schema

detail stringrequired
code string

Example (from schema)

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '/api/v3/providers/scim/:id/sync/object/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "sync_object_model": "authentik.core.models.User",
  "sync_object_id": "string"
}'

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"
}