propertymappings_provider_scope_partial_update

PATCH 
/api/v3//propertymappings/provider/scope/:pm_uuid/

ScopeMapping Viewset

Request

Path Parameters

pm_uuid uuidrequired

A UUID string identifying this Scope Mapping.

application/json

Body

managedManaged by authentik (string)nullable

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: non-empty

namestring

Possible values: non-empty

expressionstring

Possible values: non-empty

scope_namestring

Scope name requested by the client

Possible values: non-empty

descriptionstring

Description shown to the user when consenting. If left empty, the user won't be informed.

Responses

200

application/json

Schema

Schema

pkuuidrequired

managedManaged by authentik (string)nullable

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.

namestringrequired

expressionstringrequired

componentstringrequired

Get object's component so that we know how to edit the object

verbose_namestringrequired

Return object's verbose_name

verbose_name_pluralstringrequired

Return object's plural verbose_name

meta_model_namestringrequired

Return internal model name

scope_namestringrequired

Scope name requested by the client

descriptionstring

Description shown to the user when consenting. If left empty, the user won't be informed.

Example (auto)

{
  "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "managed": "string",
  "name": "string",
  "expression": "string",
  "component": "string",
  "verbose_name": "string",
  "verbose_name_plural": "string",
  "meta_model_name": "string",
  "scope_name": "string",
  "description": "string"
}

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/propertymappings/provider/scope/:pm_uuid/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"managed\": \"string\",\n  \"name\": \"string\",\n  \"expression\": \"string\",\n  \"scope_name\": \"string\",\n  \"description\": \"string\"\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

pm_uuid — pathrequired

Body

{
  "managed": "string",
  "name": "string",
  "expression": "string",
  "scope_name": "string",
  "description": "string"
}