sources_scim_retrieve
GET/api/v3//sources/scim/:slug/
SCIMSource Viewset
Request
Path Parameters
slug stringrequired
Responses
- 200
- 400
- 403
- application/json
- Schema
- Example (from schema)
Schema
pk uuidrequired
name stringrequired
Source's display Name.
slug stringrequired
Possible values: <= 50 characters
, Value must match regular expression ^[-a-zA-Z0-9_]+$
Internal source name, used in URLs.
enabled boolean
component stringrequired
Get object component so that we know how to edit the object
verbose_name stringrequired
Return object's verbose_name
verbose_name_plural stringrequired
Return object's plural verbose_name
meta_model_name stringrequired
Return internal model name
user_matching_mode UserMatchingModeEnum (string)
Possible values: [identifier
, email_link
, email_deny
, username_link
, username_deny
]
managed Managed by authentik (string)nullablerequired
Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.
user_path_template string
root_url stringrequired
Get Root URL
token_obj
object
required
{
"pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"slug": "string",
"enabled": true,
"component": "string",
"verbose_name": "string",
"verbose_name_plural": "string",
"meta_model_name": "string",
"user_matching_mode": "identifier",
"managed": "string",
"user_path_template": "string",
"root_url": "string",
"token_obj": {
"pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"managed": "string",
"identifier": "string",
"intent": "verification",
"user": 0,
"user_obj": {
"pk": 0,
"username": "string",
"name": "string",
"is_active": true,
"last_login": "2024-09-27T14:26:18.760Z",
"is_superuser": true,
"groups": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"groups_obj": [
{
"pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"num_pk": 0,
"name": "string",
"is_superuser": true,
"parent": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"parent_name": "string",
"attributes": {}
}
],
"email": "[email protected]",
"avatar": "string",
"attributes": {},
"uid": "string",
"path": "string",
"type": "internal",
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"description": "string",
"expires": "2024-09-27T14:26:18.760Z",
"expiring": true
}
}
- application/json
- Schema
- Example (from schema)
Schema
non_field_errors string[]
code string
{
"non_field_errors": [
"string"
],
"code": "string"
}
- application/json
- Schema
- Example (from schema)
Schema
detail stringrequired
code string
{
"detail": "string",
"code": "string"
}
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X GET '/api/v3/sources/scim/:slug/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'