sources_scim_retrieve
GET/sources/scim/:slug/
SCIMSource Viewset
Request
Path Parameters
Responses
- 200
- 400
- 403
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Source's display Name.
Possible values: <= 50 characters
, Value must match regular expression ^[-a-zA-Z0-9_]+$
Internal source name, used in URLs.
Get object component so that we know how to edit the object
Return object's verbose_name
Return object's plural verbose_name
Return internal model name
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.
Get Root URL
token_obj
object
required
Token Serializer
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.
Possible values: <= 255 characters
, Value must match regular expression ^[-a-zA-Z0-9_]+$
Possible values: [verification
, api
, recovery
, app_password
]
user_obj
object
required
User Serializer
Possible values: <= 150 characters
User's display name.
Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
groups_obj
object[]
nullable
required
Get a numerical, int32 ID for the group
Users added to this group will be superusers.
Possible values: <= 254 characters
User's avatar, either a http/https URL or a data URI
Possible values: [internal
, external
, service_account
, internal_service_account
]
{
"pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"slug": "string",
"enabled": true,
"user_property_mappings": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"group_property_mappings": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"component": "string",
"verbose_name": "string",
"verbose_name_plural": "string",
"meta_model_name": "string",
"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-07-29T15:51:28.071Z",
"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": "user@example.com",
"avatar": "string",
"attributes": {},
"uid": "string",
"path": "string",
"type": "internal",
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"description": "string",
"expires": "2024-07-29T15:51:28.071Z",
"expiring": true
}
}
- application/json
- Schema
- Example (from schema)
Schema
Validation Error
{
"non_field_errors": [
"string"
],
"code": "string"
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "string",
"code": "string"
}