sources_scim_users_partial_update

PATCH 
/api/v3//sources/scim_users/:id/

SCIMSourceUser Viewset

Request

Path Parameters

id stringrequired

A unique value identifying this scim source user.

application/json

Body

idstring
Possible values: non-empty
userinteger
sourceuuid
attributes

Responses

200

application/json

Schema

Schema

idstringrequired
userintegerrequired
user_obj object
Stripped down user serializer to show relevant users for groups
pkID (integer)required
usernamestringrequired
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
Possible values: <= 150 characters, Value must match regular expression ^[\w.@+-]+$
namestringrequired
User's display name.
is_activeActive (boolean)
Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
last_logindate-timenullable
emailemail
Possible values: <= 254 characters
attributes object
property name*any
uidstringrequired
sourceuuidrequired
attributes

Example (auto)

{
  "id": "string",
  "user": 0,
  "user_obj": {
    "pk": 0,
    "username": "string",
    "name": "string",
    "is_active": true,
    "last_login": "2024-07-29T15:51:28.071Z",
    "email": "user@example.com",
    "attributes": {},
    "uid": "string"
  },
  "source": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "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.Patch, "/api/v3/sources/scim_users/:id/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"id\": \"string\",\n  \"user\": 0,\n  \"source\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"attributes\": {}\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

{
  "id": "string",
  "user": 0,
  "source": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "attributes": {}
}