providers

Changed on

MicrosoftEntraProvider Viewset

get/providers/microsoft_entra/{id}/

Request

  • Base URL: https://api.goauthentik.io/api/v3
  • URL: https://api.goauthentik.io/api/v3/providers/microsoft_entra/{id}/
  • Auth: HTTP bearer

Path parameters

idinteger required

A unique integer value identifying this Microsoft Entra Provider.

Response

pkinteger required
namestring required
property_mappingsstring[]
property_mappings_groupstring[]

Property mappings used for group creation/updating.

componentstring required

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

assigned_backchannel_application_slugstring nullable required

Internal application name, used in URLs.

assigned_backchannel_application_namestring nullable required

Application's display Name.

verbose_namestring required

Return object's verbose_name

verbose_name_pluralstring required

Return object's plural verbose_name

meta_model_namestring required

Return internal model name

client_idstring required
tenant_idstring required
exclude_users_service_accountboolean
filter_groupstring uuid nullable
user_delete_action'do_nothing' | 'delete' | 'suspend'
group_delete_action'do_nothing' | 'delete' | 'suspend'
sync_page_sizeinteger

Controls the number of objects synced in a single task

discovery_enabledboolean

When enabled, authentik will attempt to discover existing resources in the remote system.

sync_page_timeoutstring

Timeout for synchronization of a single page

dry_runboolean

When enabled, provider will not modify or create objects in the remote system.

Changes