providers_microsoft_entra_create

POST 
/api/v3//providers/microsoft_entra/

MicrosoftEntraProvider Viewset

Request

application/json

Body

required

name stringrequired

Possible values: non-empty

property_mappings uuid[]
property_mappings_group uuid[]

Property mappings used for group creation/updating.

client_id stringrequired

Possible values: non-empty

client_secret stringrequired

Possible values: non-empty

tenant_id stringrequired

Possible values: non-empty

exclude_users_service_account boolean
filter_group uuidnullable
user_delete_action OutgoingSyncDeleteAction (string)

Possible values: [do_nothing, delete, suspend]

group_delete_action OutgoingSyncDeleteAction (string)

Possible values: [do_nothing, delete, suspend]

Responses

201

application/json

Schema

Schema

pk ID (integer)required
name stringrequired
property_mappings uuid[]
property_mappings_group uuid[]

Property mappings used for group creation/updating.

component stringrequired

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

assigned_backchannel_application_slug stringrequired

Internal application name, used in URLs.

assigned_backchannel_application_name stringrequired

Application's display Name.

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

client_id stringrequired
client_secret stringrequired
tenant_id stringrequired
exclude_users_service_account boolean
filter_group uuidnullable
user_delete_action OutgoingSyncDeleteAction (string)

Possible values: [do_nothing, delete, suspend]

group_delete_action OutgoingSyncDeleteAction (string)

Possible values: [do_nothing, delete, suspend]

Example (from schema)

{
  "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",
  "client_id": "string",
  "client_secret": "string",
  "tenant_id": "string",
  "exclude_users_service_account": true,
  "filter_group": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "user_delete_action": "do_nothing",
  "group_delete_action": "do_nothing"
}

400

application/json

Schema

Schema

non_field_errors string[]
code string
property name* any

Validation Error

Example (from schema)

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

403

application/json

Schema

Schema

detail stringrequired
code string

Example (from schema)

{
  "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.Post, "/api/v3/providers/microsoft_entra/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <TOKEN>");
var content = new StringContent("{\n  \"name\": \"string\",\n  \"property_mappings\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  ],\n  \"property_mappings_group\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  ],\n  \"client_id\": \"string\",\n  \"client_secret\": \"string\",\n  \"tenant_id\": \"string\",\n  \"exclude_users_service_account\": true,\n  \"filter_group\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"user_delete_action\": \"do_nothing\",\n  \"group_delete_action\": \"do_nothing\"\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

Body required

{
  "name": "string",
  "property_mappings": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "property_mappings_group": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "client_id": "string",
  "client_secret": "string",
  "tenant_id": "string",
  "exclude_users_service_account": true,
  "filter_group": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "user_delete_action": "do_nothing",
  "group_delete_action": "do_nothing"
}