providers_scim_retrieve
GET/api/v3//providers/scim/:id/
SCIMProvider Viewset
Request
Path Parameters
id integerrequired
A unique integer value identifying this SCIM Provider.
Responses
- 200
- 400
- 403
- application/json
- Schema
- Example (auto)
Schema
pkID (integer)required
namestringrequired
property_mappingsuuid[]
property_mappings_groupuuid[]
Property mappings used for group creation/updating.
componentstringrequired
Get object component so that we know how to edit the object
assigned_backchannel_application_slugstringrequired
Internal application name, used in URLs.
assigned_backchannel_application_namestringrequired
Application's display Name.
verbose_namestringrequired
Return object's verbose_name
verbose_name_pluralstringrequired
Return object's plural verbose_name
meta_model_namestringrequired
Return internal model name
urlstringrequired
Base URL to SCIM requests, usually ends in /v2
verify_certificatesboolean
tokenstringrequired
Authentication token
compatibility_modeSCIM Compatibility Mode (string)
Alter authentik behavior for vendor-specific SCIM implementations.
Possible values: [default
, aws
, slack
]
exclude_users_service_accountboolean
filter_groupuuidnullable
dry_runboolean
When enabled, provider will not modify or create objects in the remote system.
{
"pk": 0,
"name": "string",
"property_mappings": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"property_mappings_group": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"component": "string",
"assigned_backchannel_application_slug": "string",
"assigned_backchannel_application_name": "string",
"verbose_name": "string",
"verbose_name_plural": "string",
"meta_model_name": "string",
"url": "string",
"verify_certificates": true,
"token": "string",
"compatibility_mode": "default",
"exclude_users_service_account": true,
"filter_group": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"dry_run": true
}
- application/json
- Schema
- Example (auto)
Schema
non_field_errorsstring[]
codestring
property name*any
Validation Error
{
"non_field_errors": [
"string"
],
"code": "string"
}
- application/json
- Schema
- Example (auto)
Schema
detailstringrequired
codestring
{
"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.Get, "/api/v3/providers/scim/:id/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());