Management API v2

Current Version

This is the current and recommended version of the Management API. For the deprecated v1 API, see Management API v1.

The Management API v2 follows a CQRS-lite pattern with typed command DTOs for create, update, and patch operations. The generated .NET client also uses typed identifiers such as ClientAppId, SubscriptionId, and TenantId, while the HTTP API still uses UUID strings in paths and JSON payloads.

For cross-cutting behavior that is easier to explain outside the generated endpoint reference, see:

• Typed Identifiers
• Optimistic Concurrency
• Migration from v1

Option Metadata Editor Hints

OptionMetadata exposes additive v2 metadata for configuration editors:

Field	Description
dataType	Describes the stored option value semantics. Existing pre-v3 options default to String; new v3 options use more specific values such as Boolean, Integer, TimeSpan, or CommaSeparatedString.
editorType	Provides a UI hint for editors. Existing pre-v3 options default to Text; new v3 options use hints such as Checkbox, Number, Duration, or Tags.

These fields are hints only. Option values are still stored as strings, and existing validation/runtime parsing remains authoritative.

Option Target Scope

Each Option belongs to exactly one IDP instance, MFA instance, or tenant. Create commands must therefore set exactly one of applyToIdpInstanceId, applyToMfaInstanceId, or applyToTenantId.

V2 PUT and PATCH commands support changing that target. Assigning one target clears the other two target fields. Commands that assign conflicting targets are rejected. For compatibility with V2 clients generated before these fields were added to the update contract, a PUT command that omits all three target fields retains the current target. PATCH follows normal explicit-field semantics: omitted fields are unchanged, while assigning a new target clears incompatible targets.

User Questionnaire Validation

ProAuthUserQuestionnaireItem supports v2-only validation metadata for profile and MFA detail collection during login:

Field	Description
isRequired	Indicates whether a submitted value is mandatory. New and migrated items default to true. Optional items may be blank, but the item id must still be included in the submission.
minLength / maxLength	Optional string length constraints. minLength must be less than or equal to maxLength.
validationFormat	Built-in format validation. Supported values are None, Email, PhoneE164, and Regex.
validationPattern	Required when validationFormat is Regex; otherwise it is ignored. Invalid regular expressions are rejected when the item is configured.

PhoneE164 is intentionally strict and accepts only numbers matching ^\+[1-9]\d{1,14}$, for example +41791234567.

For synchronized User Store accounts, questionnaire profile answers are persisted in the User Store and synchronized to the ProAuth profile. The request to complete user details is cleared only after the User Store writes succeed. If a write fails, the request remains pending so the user can retry; writes across the two stores are not a single atomic transaction.

Client App Key Sets

ClientAppKeySet is the v2 resource for client-owned key material used by ProAuth v3 security features. Use it instead of embedding public keys in feature-specific configuration objects.

Key sets are owned by a client application and are used for:

• private_key_jwt client assertion signing keys
• JAR request-object signing keys
• self_signed_tls_client_auth certificate public keys
• token, UserInfo, ID token, and JWT introspection response encryption keys

Runtime key resolution uses key sets whose status is Active or Retiring and whose validity window is current. See Client App Key Sets for configuration guidance, source types, rotation patterns, and YAML examples.

v2.0

ProAuth Management API

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

ApplicationGroup

Operations

GET/api/management/v2/ApplicationGroup/tenant/{tenantId}GET/api/management/v2/ApplicationGroup/idpinstance/{idpInstanceId}GET/api/management/v2/ApplicationGroup/{id}GET/api/management/v2/ApplicationGroup

---

GetApplicationGroupsByTenant

GET

/api/management/v2/ApplicationGroup/tenant/{tenantId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": null,

  

  

"name": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

GetApplicationGroupsByIdpInstance

GET

/api/management/v2/ApplicationGroup/idpinstance/{idpInstanceId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": null,

  

  

"name": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

GetApplicationGroup

GET

/api/management/v2/ApplicationGroup/{id}

Responses

OK

Content-Type

application/json

{

  

"id": null,

  

"name": "string",

  

"concurrencyToken": "string"

}

---

GetApplicationGroups

GET

/api/management/v2/ApplicationGroup

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": null,

  

  

"name": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

ApplicationUser

Operations

GET/api/management/v2/ApplicationUser/tenant/{tenantId}GET/api/management/v2/ApplicationUser/idpinstance/{idpInstanceId}GET/api/management/v2/ApplicationUser/{id}GET/api/management/v2/ApplicationUser

---

GetApplicationUsersByTenant

GET

/api/management/v2/ApplicationUser/tenant/{tenantId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": null,

  

  

"firstName": "string",

  

  

"lastName": "string",

  

  

"emailAddress": "string",

  

  

"organizationalUnit": "string",

  

  

"picture": "string",

  

  

"managerId": null,

  

  

"concurrencyToken": "string"

  

}

]

---

GetApplicationUsersByIdpInstance

GET

/api/management/v2/ApplicationUser/idpinstance/{idpInstanceId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": null,

  

  

"firstName": "string",

  

  

"lastName": "string",

  

  

"emailAddress": "string",

  

  

"organizationalUnit": "string",

  

  

"picture": "string",

  

  

"managerId": null,

  

  

"concurrencyToken": "string"

  

}

]

---

GetApplicationUser

GET

/api/management/v2/ApplicationUser/{id}

Responses

OK

Content-Type

application/json

{

  

"id": null,

  

"firstName": "string",

  

"lastName": "string",

  

"emailAddress": "string",

  

"organizationalUnit": "string",

  

"picture": "string",

  

"managerId": null,

  

"concurrencyToken": "string"

}

---

GetApplicationUsers

GET

/api/management/v2/ApplicationUser

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": null,

  

  

"firstName": "string",

  

  

"lastName": "string",

  

  

"emailAddress": "string",

  

  

"organizationalUnit": "string",

  

  

"picture": "string",

  

  

"managerId": null,

  

  

"concurrencyToken": "string"

  

}

]

---

CertStore

Operations

GET/api/management/v2/CertStorePOST/api/management/v2/CertStorePUT/api/management/v2/CertStore/batchPOST/api/management/v2/CertStore/batchDELETE/api/management/v2/CertStore/batchGET/api/management/v2/CertStore/{id}PUT/api/management/v2/CertStore/{id}DELETE/api/management/v2/CertStore/{id}PATCH/api/management/v2/CertStore/{id}GET/api/management/v2/CertStore/type/{type}GET/api/management/v2/CertStore/type/{type}/subscription/{subscriptionId}GET/api/management/v2/CertStore/type/{type}/tenant/{tenantId}GET/api/management/v2/CertStore/type/{type}/idpinstance/{idpInstanceId}PUT/api/management/v2/CertStore/{id}/idpinstancesPOST/api/management/v2/CertStore/{id}/idpinstancesDELETE/api/management/v2/CertStore/{id}/idpinstances

---

GetCertStores

GET

/api/management/v2/CertStore

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"certType": "string",

  

  

"certificate": "string",

  

  

"password": "string",

  

  

"thumbprint": "string",

  

  

"validFrom": "string",

  

  

"validTo": "string",

  

  

"issuer": "string",

  

  

"serialNumber": "string",

  

  

"subject": "string",

  

  

"applyToType": "string",

  

  

"subscriptionId": "string",

  

  

"applyToSubscriptionId": "string",

  

  

"applyToTenantId": "string",

  

  

"certificateStorageFormat": "string",

  

  

"certificatePasswordProtection": "string",

  

  

"certificateHasPrivateKey": true,

  

  

"concurrencyToken": "string"

  

}

]

---

CreateCertStore

POST

/api/management/v2/CertStore

Request Body

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"certType": "string",

  

"certificate": "string",

  

"password": "string",

  

"certificateInput": null,

  

"certificateStorageFormat": "string",

  

"certificatePasswordProtection": "string",

  

"certificateHasPrivateKey": true,

  

"subscriptionId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"certType": "string",

  

"certificate": "string",

  

"password": "string",

  

"thumbprint": "string",

  

"validFrom": "string",

  

"validTo": "string",

  

"issuer": "string",

  

"serialNumber": "string",

  

"subject": "string",

  

"applyToType": "string",

  

"subscriptionId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"certificateStorageFormat": "string",

  

"certificatePasswordProtection": "string",

  

"certificateHasPrivateKey": true,

  

"concurrencyToken": "string"

}

---

UpdateCertStoreBatch

PUT

/api/management/v2/CertStore/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"certType": "string",

  

  

"certificate": "string",

  

  

"password": "string",

  

  

"certificateStorageFormat": "string",

  

  

"certificatePasswordProtection": "string",

  

  

"certificateHasPrivateKey": true,

  

  

"applyToSubscriptionId": "string",

  

  

"applyToTenantId": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateCertStoreBatch

POST

/api/management/v2/CertStore/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"certType": "string",

  

  

"certificate": "string",

  

  

"password": "string",

  

  

"certificateInput": null,

  

  

"certificateStorageFormat": "string",

  

  

"certificatePasswordProtection": "string",

  

  

"certificateHasPrivateKey": true,

  

  

"subscriptionId": "string",

  

  

"applyToSubscriptionId": "string",

  

  

"applyToTenantId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteCertStoreBatch

DELETE

/api/management/v2/CertStore/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetCertStore

GET

/api/management/v2/CertStore/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"certType": "string",

  

"certificate": "string",

  

"password": "string",

  

"thumbprint": "string",

  

"validFrom": "string",

  

"validTo": "string",

  

"issuer": "string",

  

"serialNumber": "string",

  

"subject": "string",

  

"applyToType": "string",

  

"subscriptionId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"certificateStorageFormat": "string",

  

"certificatePasswordProtection": "string",

  

"certificateHasPrivateKey": true,

  

"concurrencyToken": "string"

}

---

UpdateCertStore

PUT

/api/management/v2/CertStore/{id}

Request Body

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"certType": "string",

  

"certificate": "string",

  

"password": "string",

  

"certificateStorageFormat": "string",

  

"certificatePasswordProtection": "string",

  

"certificateHasPrivateKey": true,

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"certType": "string",

  

"certificate": "string",

  

"password": "string",

  

"thumbprint": "string",

  

"validFrom": "string",

  

"validTo": "string",

  

"issuer": "string",

  

"serialNumber": "string",

  

"subject": "string",

  

"applyToType": "string",

  

"subscriptionId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"certificateStorageFormat": "string",

  

"certificatePasswordProtection": "string",

  

"certificateHasPrivateKey": true,

  

"concurrencyToken": "string"

}

---

DeleteCertStore

DELETE

/api/management/v2/CertStore/{id}

Responses

No Content

---

PatchCertStore

PATCH

/api/management/v2/CertStore/{id}

Request Body

{

  

"name": null,

  

"description": null,

  

"certType": null,

  

"certificate": null,

  

"password": null,

  

"certificateStorageFormat": null,

  

"certificatePasswordProtection": null,

  

"certificateHasPrivateKey": null,

  

"applyToSubscriptionId": null,

  

"applyToTenantId": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"certType": "string",

  

"certificate": "string",

  

"password": "string",

  

"thumbprint": "string",

  

"validFrom": "string",

  

"validTo": "string",

  

"issuer": "string",

  

"serialNumber": "string",

  

"subject": "string",

  

"applyToType": "string",

  

"subscriptionId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"certificateStorageFormat": "string",

  

"certificatePasswordProtection": "string",

  

"certificateHasPrivateKey": true,

  

"concurrencyToken": "string"

}

---

GetAllByType

GET

/api/management/v2/CertStore/type/{type}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"certType": "string",

  

  

"certificate": "string",

  

  

"password": "string",

  

  

"thumbprint": "string",

  

  

"validFrom": "string",

  

  

"validTo": "string",

  

  

"issuer": "string",

  

  

"serialNumber": "string",

  

  

"subject": "string",

  

  

"applyToType": "string",

  

  

"subscriptionId": "string",

  

  

"applyToSubscriptionId": "string",

  

  

"applyToTenantId": "string",

  

  

"certificateStorageFormat": "string",

  

  

"certificatePasswordProtection": "string",

  

  

"certificateHasPrivateKey": true,

  

  

"concurrencyToken": "string"

  

}

]

---

GetAllByAppliedSubscriptionId

GET

/api/management/v2/CertStore/type/{type}/subscription/{subscriptionId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"certType": "string",

  

  

"certificate": "string",

  

  

"password": "string",

  

  

"thumbprint": "string",

  

  

"validFrom": "string",

  

  

"validTo": "string",

  

  

"issuer": "string",

  

  

"serialNumber": "string",

  

  

"subject": "string",

  

  

"applyToType": "string",

  

  

"subscriptionId": "string",

  

  

"applyToSubscriptionId": "string",

  

  

"applyToTenantId": "string",

  

  

"certificateStorageFormat": "string",

  

  

"certificatePasswordProtection": "string",

  

  

"certificateHasPrivateKey": true,

  

  

"concurrencyToken": "string"

  

}

]

---

GetAllByAppliedTenantId

GET

/api/management/v2/CertStore/type/{type}/tenant/{tenantId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"certType": "string",

  

  

"certificate": "string",

  

  

"password": "string",

  

  

"thumbprint": "string",

  

  

"validFrom": "string",

  

  

"validTo": "string",

  

  

"issuer": "string",

  

  

"serialNumber": "string",

  

  

"subject": "string",

  

  

"applyToType": "string",

  

  

"subscriptionId": "string",

  

  

"applyToSubscriptionId": "string",

  

  

"applyToTenantId": "string",

  

  

"certificateStorageFormat": "string",

  

  

"certificatePasswordProtection": "string",

  

  

"certificateHasPrivateKey": true,

  

  

"concurrencyToken": "string"

  

}

]

---

GetAllByInstance

GET

/api/management/v2/CertStore/type/{type}/idpinstance/{idpInstanceId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"certType": "string",

  

  

"certificate": "string",

  

  

"password": "string",

  

  

"thumbprint": "string",

  

  

"validFrom": "string",

  

  

"validTo": "string",

  

  

"issuer": "string",

  

  

"serialNumber": "string",

  

  

"subject": "string",

  

  

"applyToType": "string",

  

  

"subscriptionId": "string",

  

  

"applyToSubscriptionId": "string",

  

  

"applyToTenantId": "string",

  

  

"certificateStorageFormat": "string",

  

  

"certificatePasswordProtection": "string",

  

  

"certificateHasPrivateKey": true,

  

  

"concurrencyToken": "string"

  

}

]

---

SetCertStoreIdpInstances

PUT

/api/management/v2/CertStore/{id}/idpinstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"certType": "string",

  

"certificate": "string",

  

"password": "string",

  

"thumbprint": "string",

  

"validFrom": "string",

  

"validTo": "string",

  

"issuer": "string",

  

"serialNumber": "string",

  

"subject": "string",

  

"applyToType": "string",

  

"subscriptionId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"certificateStorageFormat": "string",

  

"certificatePasswordProtection": "string",

  

"certificateHasPrivateKey": true,

  

"concurrencyToken": "string"

}

---

AddCertStoreIdpInstance

POST

/api/management/v2/CertStore/{id}/idpinstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"certType": "string",

  

"certificate": "string",

  

"password": "string",

  

"thumbprint": "string",

  

"validFrom": "string",

  

"validTo": "string",

  

"issuer": "string",

  

"serialNumber": "string",

  

"subject": "string",

  

"applyToType": "string",

  

"subscriptionId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"certificateStorageFormat": "string",

  

"certificatePasswordProtection": "string",

  

"certificateHasPrivateKey": true,

  

"concurrencyToken": "string"

}

---

RemoveCertStoreIdpInstance

DELETE

/api/management/v2/CertStore/{id}/idpinstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"certType": "string",

  

"certificate": "string",

  

"password": "string",

  

"thumbprint": "string",

  

"validFrom": "string",

  

"validTo": "string",

  

"issuer": "string",

  

"serialNumber": "string",

  

"subject": "string",

  

"applyToType": "string",

  

"subscriptionId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"certificateStorageFormat": "string",

  

"certificatePasswordProtection": "string",

  

"certificateHasPrivateKey": true,

  

"concurrencyToken": "string"

}

---

ClaimRule

Operations

GET/api/management/v2/ClaimRulePOST/api/management/v2/ClaimRulePUT/api/management/v2/ClaimRule/batchPOST/api/management/v2/ClaimRule/batchDELETE/api/management/v2/ClaimRule/batchGET/api/management/v2/ClaimRule/{id}PUT/api/management/v2/ClaimRule/{id}DELETE/api/management/v2/ClaimRule/{id}PATCH/api/management/v2/ClaimRule/{id}PUT/api/management/v2/ClaimRule/{id}/clientappsPOST/api/management/v2/ClaimRule/{id}/clientappsDELETE/api/management/v2/ClaimRule/{id}/clientapps

---

GetClaimRules

GET

/api/management/v2/ClaimRule

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"ruleType": "string",

  

  

"filterTarget": "string",

  

  

"transformTarget": "string",

  

  

"ruleLevel": "string",

  

  

"destination": "string",

  

  

"inputSource": "string",

  

  

"disclosureMode": "string",

  

  

"priority": 0,

  

  

"typeEvaluationRule": "string",

  

  

"valueEvaluationRule": "string",

  

  

"typeTransformationRule": "string",

  

  

"valueTransformationRule": "string",

  

  

"typeTransformationReplacement": "string",

  

  

"valueTransformationReplacement": "string",

  

  

"isActive": true,

  

  

"subscriptionId": "string",

  

  

"applyToIdpInstanceId": "string",

  

  

"applyToSubscriptionId": "string",

  

  

"applyToTenantId": "string",

  

  

"clientApps": "[Circular Reference]",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateClaimRule

POST

/api/management/v2/ClaimRule

Request Body

{

  

"id": "string",

  

"name": "string",

  

"ruleType": "string",

  

"filterTarget": "string",

  

"transformTarget": "string",

  

"ruleLevel": "string",

  

"destination": "string",

  

"inputSource": "string",

  

"disclosureMode": "string",

  

"priority": 0,

  

"typeEvaluationRule": "string",

  

"valueEvaluationRule": "string",

  

"typeTransformationRule": "string",

  

"valueTransformationRule": "string",

  

"typeTransformationReplacement": "string",

  

"valueTransformationReplacement": "string",

  

"isActive": true,

  

"subscriptionId": "string",

  

"applyToIdpInstanceId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"clientApps": [

  

  

{...}

  

]

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"ruleType": "string",

  

"filterTarget": "string",

  

"transformTarget": "string",

  

"ruleLevel": "string",

  

"destination": "string",

  

"inputSource": "string",

  

"disclosureMode": "string",

  

"priority": 0,

  

"typeEvaluationRule": "string",

  

"valueEvaluationRule": "string",

  

"typeTransformationRule": "string",

  

"valueTransformationRule": "string",

  

"typeTransformationReplacement": "string",

  

"valueTransformationReplacement": "string",

  

"isActive": true,

  

"subscriptionId": "string",

  

"applyToIdpInstanceId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"clientApps": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

UpdateClaimRuleBatch

PUT

/api/management/v2/ClaimRule/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"ruleType": "string",

  

  

"filterTarget": "string",

  

  

"transformTarget": "string",

  

  

"ruleLevel": "string",

  

  

"destination": "string",

  

  

"inputSource": "string",

  

  

"disclosureMode": "string",

  

  

"priority": 0,

  

  

"typeEvaluationRule": "string",

  

  

"valueEvaluationRule": "string",

  

  

"typeTransformationRule": "string",

  

  

"valueTransformationRule": "string",

  

  

"typeTransformationReplacement": "string",

  

  

"valueTransformationReplacement": "string",

  

  

"isActive": true,

  

  

"applyToIdpInstanceId": "string",

  

  

"applyToSubscriptionId": "string",

  

  

"applyToTenantId": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateClaimRuleBatch

POST

/api/management/v2/ClaimRule/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"ruleType": "string",

  

  

"filterTarget": "string",

  

  

"transformTarget": "string",

  

  

"ruleLevel": "string",

  

  

"destination": "string",

  

  

"inputSource": "string",

  

  

"disclosureMode": "string",

  

  

"priority": 0,

  

  

"typeEvaluationRule": "string",

  

  

"valueEvaluationRule": "string",

  

  

"typeTransformationRule": "string",

  

  

"valueTransformationRule": "string",

  

  

"typeTransformationReplacement": "string",

  

  

"valueTransformationReplacement": "string",

  

  

"isActive": true,

  

  

"subscriptionId": "string",

  

  

"applyToIdpInstanceId": "string",

  

  

"applyToSubscriptionId": "string",

  

  

"applyToTenantId": "string",

  

  

"clientApps": [...]

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteClaimRuleBatch

DELETE

/api/management/v2/ClaimRule/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetClaimRule

GET

/api/management/v2/ClaimRule/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"ruleType": "string",

  

"filterTarget": "string",

  

"transformTarget": "string",

  

"ruleLevel": "string",

  

"destination": "string",

  

"inputSource": "string",

  

"disclosureMode": "string",

  

"priority": 0,

  

"typeEvaluationRule": "string",

  

"valueEvaluationRule": "string",

  

"typeTransformationRule": "string",

  

"valueTransformationRule": "string",

  

"typeTransformationReplacement": "string",

  

"valueTransformationReplacement": "string",

  

"isActive": true,

  

"subscriptionId": "string",

  

"applyToIdpInstanceId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"clientApps": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

UpdateClaimRule

PUT

/api/management/v2/ClaimRule/{id}

Request Body

{

  

"id": "string",

  

"name": "string",

  

"ruleType": "string",

  

"filterTarget": "string",

  

"transformTarget": "string",

  

"ruleLevel": "string",

  

"destination": "string",

  

"inputSource": "string",

  

"disclosureMode": "string",

  

"priority": 0,

  

"typeEvaluationRule": "string",

  

"valueEvaluationRule": "string",

  

"typeTransformationRule": "string",

  

"valueTransformationRule": "string",

  

"typeTransformationReplacement": "string",

  

"valueTransformationReplacement": "string",

  

"isActive": true,

  

"applyToIdpInstanceId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"ruleType": "string",

  

"filterTarget": "string",

  

"transformTarget": "string",

  

"ruleLevel": "string",

  

"destination": "string",

  

"inputSource": "string",

  

"disclosureMode": "string",

  

"priority": 0,

  

"typeEvaluationRule": "string",

  

"valueEvaluationRule": "string",

  

"typeTransformationRule": "string",

  

"valueTransformationRule": "string",

  

"typeTransformationReplacement": "string",

  

"valueTransformationReplacement": "string",

  

"isActive": true,

  

"subscriptionId": "string",

  

"applyToIdpInstanceId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"clientApps": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

DeleteClaimRule

DELETE

/api/management/v2/ClaimRule/{id}

Responses

No Content

---

PatchClaimRule

PATCH

/api/management/v2/ClaimRule/{id}

Request Body

{

  

"name": null,

  

"ruleType": null,

  

"filterTarget": null,

  

"transformTarget": null,

  

"ruleLevel": null,

  

"destination": null,

  

"inputSource": null,

  

"disclosureMode": null,

  

"priority": null,

  

"typeEvaluationRule": null,

  

"valueEvaluationRule": null,

  

"typeTransformationRule": null,

  

"valueTransformationRule": null,

  

"typeTransformationReplacement": null,

  

"valueTransformationReplacement": null,

  

"isActive": null,

  

"applyToIdpInstanceId": null,

  

"applyToSubscriptionId": null,

  

"applyToTenantId": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"ruleType": "string",

  

"filterTarget": "string",

  

"transformTarget": "string",

  

"ruleLevel": "string",

  

"destination": "string",

  

"inputSource": "string",

  

"disclosureMode": "string",

  

"priority": 0,

  

"typeEvaluationRule": "string",

  

"valueEvaluationRule": "string",

  

"typeTransformationRule": "string",

  

"valueTransformationRule": "string",

  

"typeTransformationReplacement": "string",

  

"valueTransformationReplacement": "string",

  

"isActive": true,

  

"subscriptionId": "string",

  

"applyToIdpInstanceId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"clientApps": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

SetClaimRuleClientApps

PUT

/api/management/v2/ClaimRule/{id}/clientapps

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"ruleType": "string",

  

"filterTarget": "string",

  

"transformTarget": "string",

  

"ruleLevel": "string",

  

"destination": "string",

  

"inputSource": "string",

  

"disclosureMode": "string",

  

"priority": 0,

  

"typeEvaluationRule": "string",

  

"valueEvaluationRule": "string",

  

"typeTransformationRule": "string",

  

"valueTransformationRule": "string",

  

"typeTransformationReplacement": "string",

  

"valueTransformationReplacement": "string",

  

"isActive": true,

  

"subscriptionId": "string",

  

"applyToIdpInstanceId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"clientApps": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

AddClaimRuleClientApp

POST

/api/management/v2/ClaimRule/{id}/clientapps

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"ruleType": "string",

  

"filterTarget": "string",

  

"transformTarget": "string",

  

"ruleLevel": "string",

  

"destination": "string",

  

"inputSource": "string",

  

"disclosureMode": "string",

  

"priority": 0,

  

"typeEvaluationRule": "string",

  

"valueEvaluationRule": "string",

  

"typeTransformationRule": "string",

  

"valueTransformationRule": "string",

  

"typeTransformationReplacement": "string",

  

"valueTransformationReplacement": "string",

  

"isActive": true,

  

"subscriptionId": "string",

  

"applyToIdpInstanceId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"clientApps": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

RemoveClaimRuleClientApp

DELETE

/api/management/v2/ClaimRule/{id}/clientapps

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"ruleType": "string",

  

"filterTarget": "string",

  

"transformTarget": "string",

  

"ruleLevel": "string",

  

"destination": "string",

  

"inputSource": "string",

  

"disclosureMode": "string",

  

"priority": 0,

  

"typeEvaluationRule": "string",

  

"valueEvaluationRule": "string",

  

"typeTransformationRule": "string",

  

"valueTransformationRule": "string",

  

"typeTransformationReplacement": "string",

  

"valueTransformationReplacement": "string",

  

"isActive": true,

  

"subscriptionId": "string",

  

"applyToIdpInstanceId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"clientApps": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

ClientAppAuthenticationConfiguration

Operations

GET/api/management/v2/ClientAppAuthenticationConfigurationPOST/api/management/v2/ClientAppAuthenticationConfigurationGET/api/management/v2/ClientAppAuthenticationConfiguration/{id}PUT/api/management/v2/ClientAppAuthenticationConfiguration/{id}DELETE/api/management/v2/ClientAppAuthenticationConfiguration/{id}PATCH/api/management/v2/ClientAppAuthenticationConfiguration/{id}PUT/api/management/v2/ClientAppAuthenticationConfiguration/batchPOST/api/management/v2/ClientAppAuthenticationConfiguration/batchDELETE/api/management/v2/ClientAppAuthenticationConfiguration/batch

---

GetClientAppAuthenticationConfigurations

GET

/api/management/v2/ClientAppAuthenticationConfiguration

Responses

OK

Content-Type

application/json

[

  

{

  

  

"clientAppId": "string",

  

  

"tokenEndpointAuthMethod": "string",

  

  

"requireCertificateBoundAccessTokens": true,

  

  

"dpopBoundAccessTokens": true,

  

  

"requireDpopNonce": true,

  

  

"tlsClientAuthSubjectDn": "string",

  

  

"tlsClientAuthSanDns": "string",

  

  

"tlsClientAuthSanUri": "string",

  

  

"tlsClientAuthSanIp": "string",

  

  

"tlsClientAuthSanEmail": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateClientAppAuthenticationConfiguration

POST

/api/management/v2/ClientAppAuthenticationConfiguration

Request Body

{

  

"clientAppId": "string",

  

"tokenEndpointAuthMethod": "string",

  

"requireCertificateBoundAccessTokens": true,

  

"dpopBoundAccessTokens": true,

  

"requireDpopNonce": true,

  

"tlsClientAuthSubjectDn": "string",

  

"tlsClientAuthSanDns": "string",

  

"tlsClientAuthSanUri": "string",

  

"tlsClientAuthSanIp": "string",

  

"tlsClientAuthSanEmail": "string"

}

Responses

Created

Content-Type

application/json

{

  

"clientAppId": "string",

  

"tokenEndpointAuthMethod": "string",

  

"requireCertificateBoundAccessTokens": true,

  

"dpopBoundAccessTokens": true,

  

"requireDpopNonce": true,

  

"tlsClientAuthSubjectDn": "string",

  

"tlsClientAuthSanDns": "string",

  

"tlsClientAuthSanUri": "string",

  

"tlsClientAuthSanIp": "string",

  

"tlsClientAuthSanEmail": "string",

  

"concurrencyToken": "string"

}

---

GetClientAppAuthenticationConfiguration

GET

/api/management/v2/ClientAppAuthenticationConfiguration/{id}

Responses

OK

Content-Type

application/json

{

  

"clientAppId": "string",

  

"tokenEndpointAuthMethod": "string",

  

"requireCertificateBoundAccessTokens": true,

  

"dpopBoundAccessTokens": true,

  

"requireDpopNonce": true,

  

"tlsClientAuthSubjectDn": "string",

  

"tlsClientAuthSanDns": "string",

  

"tlsClientAuthSanUri": "string",

  

"tlsClientAuthSanIp": "string",

  

"tlsClientAuthSanEmail": "string",

  

"concurrencyToken": "string"

}

---

UpdateClientAppAuthenticationConfiguration

PUT

/api/management/v2/ClientAppAuthenticationConfiguration/{id}

Request Body

{

  

"tokenEndpointAuthMethod": "string",

  

"requireCertificateBoundAccessTokens": true,

  

"dpopBoundAccessTokens": true,

  

"requireDpopNonce": true,

  

"tlsClientAuthSubjectDn": "string",

  

"tlsClientAuthSanDns": "string",

  

"tlsClientAuthSanUri": "string",

  

"tlsClientAuthSanIp": "string",

  

"tlsClientAuthSanEmail": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"clientAppId": "string",

  

"tokenEndpointAuthMethod": "string",

  

"requireCertificateBoundAccessTokens": true,

  

"dpopBoundAccessTokens": true,

  

"requireDpopNonce": true,

  

"tlsClientAuthSubjectDn": "string",

  

"tlsClientAuthSanDns": "string",

  

"tlsClientAuthSanUri": "string",

  

"tlsClientAuthSanIp": "string",

  

"tlsClientAuthSanEmail": "string",

  

"concurrencyToken": "string"

}

---

DeleteClientAppAuthenticationConfiguration

DELETE

/api/management/v2/ClientAppAuthenticationConfiguration/{id}

Responses

No Content

---

PatchClientAppAuthenticationConfiguration

PATCH

/api/management/v2/ClientAppAuthenticationConfiguration/{id}

Request Body

{

  

"tokenEndpointAuthMethod": "string",

  

"requireCertificateBoundAccessTokens": true,

  

"dpopBoundAccessTokens": true,

  

"requireDpopNonce": true,

  

"tlsClientAuthSubjectDn": "string",

  

"tlsClientAuthSanDns": "string",

  

"tlsClientAuthSanUri": "string",

  

"tlsClientAuthSanIp": "string",

  

"tlsClientAuthSanEmail": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"clientAppId": "string",

  

"tokenEndpointAuthMethod": "string",

  

"requireCertificateBoundAccessTokens": true,

  

"dpopBoundAccessTokens": true,

  

"requireDpopNonce": true,

  

"tlsClientAuthSubjectDn": "string",

  

"tlsClientAuthSanDns": "string",

  

"tlsClientAuthSanUri": "string",

  

"tlsClientAuthSanIp": "string",

  

"tlsClientAuthSanEmail": "string",

  

"concurrencyToken": "string"

}

---

UpdateClientAppAuthenticationConfigurations

PUT

/api/management/v2/ClientAppAuthenticationConfiguration/batch

Request Body

[

  

{

  

  

"tokenEndpointAuthMethod": "string",

  

  

"requireCertificateBoundAccessTokens": true,

  

  

"dpopBoundAccessTokens": true,

  

  

"requireDpopNonce": true,

  

  

"tlsClientAuthSubjectDn": "string",

  

  

"tlsClientAuthSanDns": "string",

  

  

"tlsClientAuthSanUri": "string",

  

  

"tlsClientAuthSanIp": "string",

  

  

"tlsClientAuthSanEmail": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateClientAppAuthenticationConfigurations

POST

/api/management/v2/ClientAppAuthenticationConfiguration/batch

Request Body

[

  

{

  

  

"clientAppId": "string",

  

  

"tokenEndpointAuthMethod": "string",

  

  

"requireCertificateBoundAccessTokens": true,

  

  

"dpopBoundAccessTokens": true,

  

  

"requireDpopNonce": true,

  

  

"tlsClientAuthSubjectDn": "string",

  

  

"tlsClientAuthSanDns": "string",

  

  

"tlsClientAuthSanUri": "string",

  

  

"tlsClientAuthSanIp": "string",

  

  

"tlsClientAuthSanEmail": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteClientAppAuthenticationConfigurations

DELETE

/api/management/v2/ClientAppAuthenticationConfiguration/batch

Request Body

[

  

"string"

]

Responses

No Content

---

ClientApp

Operations

GET/api/management/v2/ClientAppPOST/api/management/v2/ClientAppPUT/api/management/v2/ClientApp/batchPOST/api/management/v2/ClientApp/batchDELETE/api/management/v2/ClientApp/batchGET/api/management/v2/ClientApp/{id}PUT/api/management/v2/ClientApp/{id}DELETE/api/management/v2/ClientApp/{id}PATCH/api/management/v2/ClientApp/{id}GET/api/management/v2/ClientApp/subscription/{subscriptionId}PUT/api/management/v2/ClientApp/{id}/tenantsPOST/api/management/v2/ClientApp/{id}/tenantsDELETE/api/management/v2/ClientApp/{id}/tenantsPUT/api/management/v2/ClientApp/{id}/idpinstancesPOST/api/management/v2/ClientApp/{id}/idpinstancesDELETE/api/management/v2/ClientApp/{id}/idpinstancesPUT/api/management/v2/ClientApp/{id}/mfainstancesPOST/api/management/v2/ClientApp/{id}/mfainstancesDELETE/api/management/v2/ClientApp/{id}/mfainstancesPUT/api/management/v2/ClientApp/{id}/claimrulesPOST/api/management/v2/ClientApp/{id}/claimrulesDELETE/api/management/v2/ClientApp/{id}/claimrulesPUT/api/management/v2/ClientApp/{id}/allowedtokenexchangeclientappsPOST/api/management/v2/ClientApp/{id}/allowedtokenexchangeclientappsDELETE/api/management/v2/ClientApp/{id}/allowedtokenexchangeclientappsPUT/api/management/v2/ClientApp/{id}/authorizedgroupsPOST/api/management/v2/ClientApp/{id}/authorizedgroupsDELETE/api/management/v2/ClientApp/{id}/authorizedgroupsPUT/api/management/v2/ClientApp/{id}/authorizedusersPOST/api/management/v2/ClientApp/{id}/authorizedusersDELETE/api/management/v2/ClientApp/{id}/authorizedusers

---

GetClientApps

GET

/api/management/v2/ClientApp

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"accessGrantConsent": "string",

  

  

"logoutConsent": "string",

  

  

"resourceFilterEnabled": true,

  

  

"scopeFilterEnabled": true,

  

  

"clientUri": "string",

  

  

"logoUri": "string",

  

  

"backchannelLogoutUri": "string",

  

  

"backchannelLogoutSessionRequired": true,

  

  

"frontchannelLogoutUri": "string",

  

  

"frontchannelLogoutSessionRequired": true,

  

  

"enabled": true,

  

  

"isPublic": true,

  

  

"isNativeApplication": true,

  

  

"allowedResponseTypes": "string",

  

  

"isRestricted": true,

  

  

"includeGroupsClaims": true,

  

  

"allowCrossSubscription": true,

  

  

"allowUserLogin": true,

  

  

"allowClientCredentialLogin": true,

  

  

"accessTokenType": "string",

  

  

"securityProfile": "string",

  

  

"subjectType": "string",

  

  

"sectorIdentifierUri": "string",

  

  

"accessTokenEncryptionEnabledOverride": true,

  

  

"idTokenEncryptedResponseAlg": "string",

  

  

"idTokenEncryptedResponseEnc": "string",

  

  

"userinfoEncryptedResponseAlg": "string",

  

  

"userinfoEncryptedResponseEnc": "string",

  

  

"introspectionEncryptedResponseAlg": "string",

  

  

"introspectionEncryptedResponseEnc": "string",

  

  

"requirePushedAuthorizationRequests": true,

  

  

"requestObjectSigningAlg": "string",

  

  

"requestObjectEncryptionAlg": "string",

  

  

"requestObjectEncryptionEnc": "string",

  

  

"allowDeviceAuthorizationGrant": true,

  

  

"subscriptionId": "string",

  

  

"clientAppAuthenticationConfiguration": null,

  

  

"clientAppRedirectUris": [...],

  

  

"clientAppKeySets": [...],

  

  

"clientAppResources": [...],

  

  

"clientAppSecrets": [...],

  

  

"clientAppRequestUris": [...],

  

  

"clientAppFederatedIdentities": [...],

  

  

"metadata": [...],

  

  

"claimRules": [...],

  

  

"clientAppScopes": [...],

  

  

"authorizedProAuthUsers": [...],

  

  

"authorizedProAuthGroups": [...],

  

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

  

"tenants": [...],

  

  

"idpInstances": [...],

  

  

"mfaInstances": [...],

  

  

"concurrencyToken": "string"

  

}

]

---

CreateClientApp

POST

/api/management/v2/ClientApp

Request Body

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

UpdateClientAppBatch

PUT

/api/management/v2/ClientApp/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"accessGrantConsent": "string",

  

  

"logoutConsent": "string",

  

  

"resourceFilterEnabled": true,

  

  

"scopeFilterEnabled": true,

  

  

"clientUri": "string",

  

  

"logoUri": "string",

  

  

"backchannelLogoutUri": "string",

  

  

"backchannelLogoutSessionRequired": true,

  

  

"frontchannelLogoutUri": "string",

  

  

"frontchannelLogoutSessionRequired": true,

  

  

"enabled": true,

  

  

"isPublic": true,

  

  

"isNativeApplication": true,

  

  

"allowedResponseTypes": "string",

  

  

"isRestricted": true,

  

  

"includeGroupsClaims": true,

  

  

"allowCrossSubscription": true,

  

  

"allowUserLogin": true,

  

  

"allowClientCredentialLogin": true,

  

  

"accessTokenType": "string",

  

  

"securityProfile": "string",

  

  

"subjectType": "string",

  

  

"sectorIdentifierUri": "string",

  

  

"accessTokenEncryptionEnabledOverride": true,

  

  

"idTokenEncryptedResponseAlg": "string",

  

  

"idTokenEncryptedResponseEnc": "string",

  

  

"userinfoEncryptedResponseAlg": "string",

  

  

"userinfoEncryptedResponseEnc": "string",

  

  

"introspectionEncryptedResponseAlg": "string",

  

  

"introspectionEncryptedResponseEnc": "string",

  

  

"requirePushedAuthorizationRequests": true,

  

  

"requestObjectSigningAlg": "string",

  

  

"requestObjectEncryptionAlg": "string",

  

  

"requestObjectEncryptionEnc": "string",

  

  

"allowDeviceAuthorizationGrant": true,

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateClientAppBatch

POST

/api/management/v2/ClientApp/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"accessGrantConsent": "string",

  

  

"logoutConsent": "string",

  

  

"resourceFilterEnabled": true,

  

  

"scopeFilterEnabled": true,

  

  

"clientUri": "string",

  

  

"logoUri": "string",

  

  

"backchannelLogoutUri": "string",

  

  

"backchannelLogoutSessionRequired": true,

  

  

"frontchannelLogoutUri": "string",

  

  

"frontchannelLogoutSessionRequired": true,

  

  

"enabled": true,

  

  

"isPublic": true,

  

  

"isNativeApplication": true,

  

  

"allowedResponseTypes": "string",

  

  

"isRestricted": true,

  

  

"includeGroupsClaims": true,

  

  

"allowCrossSubscription": true,

  

  

"allowUserLogin": true,

  

  

"allowClientCredentialLogin": true,

  

  

"accessTokenType": "string",

  

  

"securityProfile": "string",

  

  

"subjectType": "string",

  

  

"sectorIdentifierUri": "string",

  

  

"accessTokenEncryptionEnabledOverride": true,

  

  

"idTokenEncryptedResponseAlg": "string",

  

  

"idTokenEncryptedResponseEnc": "string",

  

  

"userinfoEncryptedResponseAlg": "string",

  

  

"userinfoEncryptedResponseEnc": "string",

  

  

"introspectionEncryptedResponseAlg": "string",

  

  

"introspectionEncryptedResponseEnc": "string",

  

  

"requirePushedAuthorizationRequests": true,

  

  

"requestObjectSigningAlg": "string",

  

  

"requestObjectEncryptionAlg": "string",

  

  

"requestObjectEncryptionEnc": "string",

  

  

"allowDeviceAuthorizationGrant": true,

  

  

"subscriptionId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteClientAppBatch

DELETE

/api/management/v2/ClientApp/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetClientApp

GET

/api/management/v2/ClientApp/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

UpdateClientApp

PUT

/api/management/v2/ClientApp/{id}

Request Body

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

DeleteClientApp

DELETE

/api/management/v2/ClientApp/{id}

Responses

No Content

---

PatchClientApp

PATCH

/api/management/v2/ClientApp/{id}

Request Body

{

  

"name": null,

  

"accessGrantConsent": null,

  

"logoutConsent": null,

  

"resourceFilterEnabled": null,

  

"scopeFilterEnabled": null,

  

"clientUri": null,

  

"logoUri": null,

  

"backchannelLogoutUri": null,

  

"backchannelLogoutSessionRequired": null,

  

"frontchannelLogoutUri": null,

  

"frontchannelLogoutSessionRequired": null,

  

"enabled": null,

  

"isPublic": null,

  

"isNativeApplication": null,

  

"allowedResponseTypes": null,

  

"isRestricted": null,

  

"includeGroupsClaims": null,

  

"allowCrossSubscription": null,

  

"allowUserLogin": null,

  

"allowClientCredentialLogin": null,

  

"accessTokenType": null,

  

"securityProfile": null,

  

"subjectType": null,

  

"sectorIdentifierUri": null,

  

"accessTokenEncryptionEnabledOverride": null,

  

"idTokenEncryptedResponseAlg": null,

  

"idTokenEncryptedResponseEnc": null,

  

"userinfoEncryptedResponseAlg": null,

  

"userinfoEncryptedResponseEnc": null,

  

"introspectionEncryptedResponseAlg": null,

  

"introspectionEncryptedResponseEnc": null,

  

"requirePushedAuthorizationRequests": null,

  

"requestObjectSigningAlg": null,

  

"requestObjectEncryptionAlg": null,

  

"requestObjectEncryptionEnc": null,

  

"allowDeviceAuthorizationGrant": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

GetClientAppsBySubscriptionId

GET

/api/management/v2/ClientApp/subscription/{subscriptionId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"accessGrantConsent": "string",

  

  

"logoutConsent": "string",

  

  

"resourceFilterEnabled": true,

  

  

"scopeFilterEnabled": true,

  

  

"clientUri": "string",

  

  

"logoUri": "string",

  

  

"backchannelLogoutUri": "string",

  

  

"backchannelLogoutSessionRequired": true,

  

  

"frontchannelLogoutUri": "string",

  

  

"frontchannelLogoutSessionRequired": true,

  

  

"enabled": true,

  

  

"isPublic": true,

  

  

"isNativeApplication": true,

  

  

"allowedResponseTypes": "string",

  

  

"isRestricted": true,

  

  

"includeGroupsClaims": true,

  

  

"allowCrossSubscription": true,

  

  

"allowUserLogin": true,

  

  

"allowClientCredentialLogin": true,

  

  

"accessTokenType": "string",

  

  

"securityProfile": "string",

  

  

"subjectType": "string",

  

  

"sectorIdentifierUri": "string",

  

  

"accessTokenEncryptionEnabledOverride": true,

  

  

"idTokenEncryptedResponseAlg": "string",

  

  

"idTokenEncryptedResponseEnc": "string",

  

  

"userinfoEncryptedResponseAlg": "string",

  

  

"userinfoEncryptedResponseEnc": "string",

  

  

"introspectionEncryptedResponseAlg": "string",

  

  

"introspectionEncryptedResponseEnc": "string",

  

  

"requirePushedAuthorizationRequests": true,

  

  

"requestObjectSigningAlg": "string",

  

  

"requestObjectEncryptionAlg": "string",

  

  

"requestObjectEncryptionEnc": "string",

  

  

"allowDeviceAuthorizationGrant": true,

  

  

"subscriptionId": "string",

  

  

"clientAppAuthenticationConfiguration": null,

  

  

"clientAppRedirectUris": [...],

  

  

"clientAppKeySets": [...],

  

  

"clientAppResources": [...],

  

  

"clientAppSecrets": [...],

  

  

"clientAppRequestUris": [...],

  

  

"clientAppFederatedIdentities": [...],

  

  

"metadata": [...],

  

  

"claimRules": [...],

  

  

"clientAppScopes": [...],

  

  

"authorizedProAuthUsers": [...],

  

  

"authorizedProAuthGroups": [...],

  

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

  

"tenants": [...],

  

  

"idpInstances": [...],

  

  

"mfaInstances": [...],

  

  

"concurrencyToken": "string"

  

}

]

---

SetTenants

PUT

/api/management/v2/ClientApp/{id}/tenants

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

AddTenant

POST

/api/management/v2/ClientApp/{id}/tenants

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

RemoveTenant

DELETE

/api/management/v2/ClientApp/{id}/tenants

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

SetClientAppIdpInstances

PUT

/api/management/v2/ClientApp/{id}/idpinstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

AddClientAppIdpInstance

POST

/api/management/v2/ClientApp/{id}/idpinstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

RemoveClientAppIdpInstance

DELETE

/api/management/v2/ClientApp/{id}/idpinstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

SetClientAppMfaInstances

PUT

/api/management/v2/ClientApp/{id}/mfainstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

AddClientAppMfaInstance

POST

/api/management/v2/ClientApp/{id}/mfainstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

RemoveClientAppMfaInstance

DELETE

/api/management/v2/ClientApp/{id}/mfainstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

SetClaimRules

PUT

/api/management/v2/ClientApp/{id}/claimrules

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

AddClaimRule

POST

/api/management/v2/ClientApp/{id}/claimrules

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

RemoveClaimRule

DELETE

/api/management/v2/ClientApp/{id}/claimrules

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

SetAllowedTokenExchangeClientApps

PUT

/api/management/v2/ClientApp/{id}/allowedtokenexchangeclientapps

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

AddAllowedTokenExchangeClientApp

POST

/api/management/v2/ClientApp/{id}/allowedtokenexchangeclientapps

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

RemoveAllowedTokenExchangeClientApp

DELETE

/api/management/v2/ClientApp/{id}/allowedtokenexchangeclientapps

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

SetAuthorizedProAuthGroups

PUT

/api/management/v2/ClientApp/{id}/authorizedgroups

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

AddAuthorizedProAuthGroup

POST

/api/management/v2/ClientApp/{id}/authorizedgroups

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

RemoveAuthorizedProAuthGroup

DELETE

/api/management/v2/ClientApp/{id}/authorizedgroups

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

SetAuthorizedProAuthUsers

PUT

/api/management/v2/ClientApp/{id}/authorizedusers

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

AddAuthorizedProAuthUser

POST

/api/management/v2/ClientApp/{id}/authorizedusers

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

RemoveAuthorizedProAuthUser

DELETE

/api/management/v2/ClientApp/{id}/authorizedusers

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"resourceFilterEnabled": true,

  

"scopeFilterEnabled": true,

  

"clientUri": "string",

  

"logoUri": "string",

  

"backchannelLogoutUri": "string",

  

"backchannelLogoutSessionRequired": true,

  

"frontchannelLogoutUri": "string",

  

"frontchannelLogoutSessionRequired": true,

  

"enabled": true,

  

"isPublic": true,

  

"isNativeApplication": true,

  

"allowedResponseTypes": "string",

  

"isRestricted": true,

  

"includeGroupsClaims": true,

  

"allowCrossSubscription": true,

  

"allowUserLogin": true,

  

"allowClientCredentialLogin": true,

  

"accessTokenType": "string",

  

"securityProfile": "string",

  

"subjectType": "string",

  

"sectorIdentifierUri": "string",

  

"accessTokenEncryptionEnabledOverride": true,

  

"idTokenEncryptedResponseAlg": "string",

  

"idTokenEncryptedResponseEnc": "string",

  

"userinfoEncryptedResponseAlg": "string",

  

"userinfoEncryptedResponseEnc": "string",

  

"introspectionEncryptedResponseAlg": "string",

  

"introspectionEncryptedResponseEnc": "string",

  

"requirePushedAuthorizationRequests": true,

  

"requestObjectSigningAlg": "string",

  

"requestObjectEncryptionAlg": "string",

  

"requestObjectEncryptionEnc": "string",

  

"allowDeviceAuthorizationGrant": true,

  

"subscriptionId": "string",

  

"clientAppAuthenticationConfiguration": null,

  

"clientAppRedirectUris": [

  

  

{...}

  

],

  

"clientAppKeySets": [

  

  

{...}

  

],

  

"clientAppResources": [

  

  

{...}

  

],

  

"clientAppSecrets": [

  

  

{...}

  

],

  

"clientAppRequestUris": [

  

  

{...}

  

],

  

"clientAppFederatedIdentities": [

  

  

{...}

  

],

  

"metadata": [

  

  

{...}

  

],

  

"claimRules": [

  

  

{...}

  

],

  

"clientAppScopes": [

  

  

{...}

  

],

  

"authorizedProAuthUsers": [

  

  

{...}

  

],

  

"authorizedProAuthGroups": [

  

],

  

"allowedTokenExchangeClientApps": "[Circular Reference]",

  

"tenants": [

  

],

  

"idpInstances": [

  

],

  

"mfaInstances": [

  

],

  

"concurrencyToken": "string"

}

---

ClientAppFederatedConfiguration

Operations

GET/api/management/v2/ClientAppFederatedConfigurationPOST/api/management/v2/ClientAppFederatedConfigurationPUT/api/management/v2/ClientAppFederatedConfiguration/batchPOST/api/management/v2/ClientAppFederatedConfiguration/batchDELETE/api/management/v2/ClientAppFederatedConfiguration/batchGET/api/management/v2/ClientAppFederatedConfiguration/{id}PUT/api/management/v2/ClientAppFederatedConfiguration/{id}DELETE/api/management/v2/ClientAppFederatedConfiguration/{id}PATCH/api/management/v2/ClientAppFederatedConfiguration/{id}GET/api/management/v2/ClientAppFederatedConfiguration/clientapp/{clientAppId}

---

GetClientAppFederatedConfigurations

GET

/api/management/v2/ClientAppFederatedConfiguration

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"issuer": "string",

  

  

"subject": "string",

  

  

"clientAppId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateClientAppFederatedConfiguration

POST

/api/management/v2/ClientAppFederatedConfiguration

Request Body

{

  

"id": "string",

  

"issuer": "string",

  

"subject": "string",

  

"clientAppId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"issuer": "string",

  

"subject": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

UpdateClientAppFederatedConfigurationBatch

PUT

/api/management/v2/ClientAppFederatedConfiguration/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"issuer": "string",

  

  

"subject": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateClientAppFederatedConfigurationBatch

POST

/api/management/v2/ClientAppFederatedConfiguration/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"issuer": "string",

  

  

"subject": "string",

  

  

"clientAppId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteClientAppFederatedConfigurationBatch

DELETE

/api/management/v2/ClientAppFederatedConfiguration/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetClientAppFederatedConfiguration

GET

/api/management/v2/ClientAppFederatedConfiguration/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"issuer": "string",

  

"subject": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

UpdateClientAppFederatedConfiguration

PUT

/api/management/v2/ClientAppFederatedConfiguration/{id}

Request Body

{

  

"id": "string",

  

"issuer": "string",

  

"subject": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"issuer": "string",

  

"subject": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

DeleteClientAppFederatedConfiguration

DELETE

/api/management/v2/ClientAppFederatedConfiguration/{id}

Responses

No Content

---

PatchClientAppFederatedConfiguration

PATCH

/api/management/v2/ClientAppFederatedConfiguration/{id}

Request Body

{

  

"issuer": null,

  

"subject": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"issuer": "string",

  

"subject": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

GetClientAppFederatedConfigurationsByClientAppId

GET

/api/management/v2/ClientAppFederatedConfiguration/clientapp/{clientAppId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"issuer": "string",

  

  

"subject": "string",

  

  

"clientAppId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

ClientAppKeySet

Operations

GET/api/management/v2/ClientAppKeySet/clientapp/{clientAppId}GET/api/management/v2/ClientAppKeySetPOST/api/management/v2/ClientAppKeySetGET/api/management/v2/ClientAppKeySet/{id}PUT/api/management/v2/ClientAppKeySet/{id}DELETE/api/management/v2/ClientAppKeySet/{id}PATCH/api/management/v2/ClientAppKeySet/{id}PUT/api/management/v2/ClientAppKeySet/batchPOST/api/management/v2/ClientAppKeySet/batchDELETE/api/management/v2/ClientAppKeySet/batch

---

GetByClientAppId

GET

/api/management/v2/ClientAppKeySet/clientapp/{clientAppId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"sourceType": "string",

  

  

"usage": "string",

  

  

"status": "string",

  

  

"jwksUri": "string",

  

  

"jwksJson": "string",

  

  

"validFrom": "string",

  

  

"validTo": "string",

  

  

"lastValidatedOn": "string",

  

  

"lastValidationError": "string",

  

  

"clientAppId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

GetClientAppKeySets

GET

/api/management/v2/ClientAppKeySet

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"sourceType": "string",

  

  

"usage": "string",

  

  

"status": "string",

  

  

"jwksUri": "string",

  

  

"jwksJson": "string",

  

  

"validFrom": "string",

  

  

"validTo": "string",

  

  

"lastValidatedOn": "string",

  

  

"lastValidationError": "string",

  

  

"clientAppId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateClientAppKeySet

POST

/api/management/v2/ClientAppKeySet

Request Body

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"sourceType": "string",

  

"usage": "string",

  

"status": "string",

  

"jwksUri": "string",

  

"jwksJson": "string",

  

"protectedJwksJson": "string",

  

"validFrom": "string",

  

"validTo": "string",

  

"clientAppId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"sourceType": "string",

  

"usage": "string",

  

"status": "string",

  

"jwksUri": "string",

  

"jwksJson": "string",

  

"validFrom": "string",

  

"validTo": "string",

  

"lastValidatedOn": "string",

  

"lastValidationError": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

GetClientAppKeySet

GET

/api/management/v2/ClientAppKeySet/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"sourceType": "string",

  

"usage": "string",

  

"status": "string",

  

"jwksUri": "string",

  

"jwksJson": "string",

  

"validFrom": "string",

  

"validTo": "string",

  

"lastValidatedOn": "string",

  

"lastValidationError": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

UpdateClientAppKeySet

PUT

/api/management/v2/ClientAppKeySet/{id}

Request Body

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"sourceType": "string",

  

"usage": "string",

  

"status": "string",

  

"jwksUri": "string",

  

"jwksJson": "string",

  

"protectedJwksJson": "string",

  

"validFrom": "string",

  

"validTo": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"sourceType": "string",

  

"usage": "string",

  

"status": "string",

  

"jwksUri": "string",

  

"jwksJson": "string",

  

"validFrom": "string",

  

"validTo": "string",

  

"lastValidatedOn": "string",

  

"lastValidationError": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

DeleteClientAppKeySet

DELETE

/api/management/v2/ClientAppKeySet/{id}

Responses

No Content

---

PatchClientAppKeySet

PATCH

/api/management/v2/ClientAppKeySet/{id}

Request Body

{

  

"name": null,

  

"description": null,

  

"sourceType": null,

  

"usage": null,

  

"status": null,

  

"jwksUri": null,

  

"jwksJson": null,

  

"protectedJwksJson": null,

  

"validFrom": null,

  

"validTo": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"sourceType": "string",

  

"usage": "string",

  

"status": "string",

  

"jwksUri": "string",

  

"jwksJson": "string",

  

"validFrom": "string",

  

"validTo": "string",

  

"lastValidatedOn": "string",

  

"lastValidationError": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

UpdateClientAppKeySets

PUT

/api/management/v2/ClientAppKeySet/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"sourceType": "string",

  

  

"usage": "string",

  

  

"status": "string",

  

  

"jwksUri": "string",

  

  

"jwksJson": "string",

  

  

"protectedJwksJson": "string",

  

  

"validFrom": "string",

  

  

"validTo": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateClientAppKeySets

POST

/api/management/v2/ClientAppKeySet/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"sourceType": "string",

  

  

"usage": "string",

  

  

"status": "string",

  

  

"jwksUri": "string",

  

  

"jwksJson": "string",

  

  

"protectedJwksJson": "string",

  

  

"validFrom": "string",

  

  

"validTo": "string",

  

  

"clientAppId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteClientAppKeySets

DELETE

/api/management/v2/ClientAppKeySet/batch

Request Body

[

  

"string"

]

Responses

No Content

---

ClientAppMetadata

Operations

GET/api/management/v2/ClientAppMetadata/{clientAppId}POST/api/management/v2/ClientAppMetadata/{clientAppId}GET/api/management/v2/ClientAppMetadata/{clientAppId}/{key}PUT/api/management/v2/ClientAppMetadata/{clientAppId}/{key}DELETE/api/management/v2/ClientAppMetadata/{clientAppId}/{key}PATCH/api/management/v2/ClientAppMetadata/{clientAppId}/{key}

---

GetClientAppMetadataByClientAppId

GET

/api/management/v2/ClientAppMetadata/{clientAppId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"clientAppId": "string",

  

  

"key": "string",

  

  

"value": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateClientAppMetadata

POST

/api/management/v2/ClientAppMetadata/{clientAppId}

Request Body

{

  

"clientAppId": "string",

  

"key": "string",

  

"value": "string"

}

Responses

OK

Content-Type

application/json

{

  

"clientAppId": "string",

  

"key": "string",

  

"value": "string",

  

"concurrencyToken": "string"

}

---

GetClientAppMetadata

GET

/api/management/v2/ClientAppMetadata/{clientAppId}/{key}

Responses

OK

Content-Type

application/json

{

  

"clientAppId": "string",

  

"key": "string",

  

"value": "string",

  

"concurrencyToken": "string"

}

---

UpdateClientAppMetadata

PUT

/api/management/v2/ClientAppMetadata/{clientAppId}/{key}

Request Body

{

  

"value": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"clientAppId": "string",

  

"key": "string",

  

"value": "string",

  

"concurrencyToken": "string"

}

---

DeleteClientAppMetadata

DELETE

/api/management/v2/ClientAppMetadata/{clientAppId}/{key}

Responses

Bad Request

Content-Type

application/json

{

  

"type": "string",

  

"title": "string",

  

"status": null,

  

"detail": "string",

  

"instance": "string"

}

---

PatchClientAppMetadata

PATCH

/api/management/v2/ClientAppMetadata/{clientAppId}/{key}

Request Body

{

  

"value": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"clientAppId": "string",

  

"key": "string",

  

"value": "string",

  

"concurrencyToken": "string"

}

---

ClientAppRedirectUri

Operations

GET/api/management/v2/ClientAppRedirectUriPOST/api/management/v2/ClientAppRedirectUriPUT/api/management/v2/ClientAppRedirectUri/batchPOST/api/management/v2/ClientAppRedirectUri/batchDELETE/api/management/v2/ClientAppRedirectUri/batchGET/api/management/v2/ClientAppRedirectUri/{id}PUT/api/management/v2/ClientAppRedirectUri/{id}DELETE/api/management/v2/ClientAppRedirectUri/{id}PATCH/api/management/v2/ClientAppRedirectUri/{id}GET/api/management/v2/ClientAppRedirectUri/clientapp/{clientAppId}

---

GetClientAppRedirectUris

GET

/api/management/v2/ClientAppRedirectUri

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"uri": "string",

  

  

"redirectType": "string",

  

  

"clientAppId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateClientAppRedirectUri

POST

/api/management/v2/ClientAppRedirectUri

Request Body

{

  

"id": "string",

  

"uri": "string",

  

"redirectType": "string",

  

"clientAppId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"uri": "string",

  

"redirectType": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

UpdateClientAppRedirectUriBatch

PUT

/api/management/v2/ClientAppRedirectUri/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"uri": "string",

  

  

"redirectType": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateClientAppRedirectUriBatch

POST

/api/management/v2/ClientAppRedirectUri/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"uri": "string",

  

  

"redirectType": "string",

  

  

"clientAppId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteClientAppRedirectUriBatch

DELETE

/api/management/v2/ClientAppRedirectUri/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetClientAppRedirectUri

GET

/api/management/v2/ClientAppRedirectUri/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"uri": "string",

  

"redirectType": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

UpdateClientAppRedirectUri

PUT

/api/management/v2/ClientAppRedirectUri/{id}

Request Body

{

  

"id": "string",

  

"uri": "string",

  

"redirectType": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"uri": "string",

  

"redirectType": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

DeleteClientAppRedirectUri

DELETE

/api/management/v2/ClientAppRedirectUri/{id}

Responses

No Content

---

PatchClientAppRedirectUri

PATCH

/api/management/v2/ClientAppRedirectUri/{id}

Request Body

{

  

"uri": null,

  

"redirectType": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"uri": "string",

  

"redirectType": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

GetClientAppRedirectUrisByClientAppId

GET

/api/management/v2/ClientAppRedirectUri/clientapp/{clientAppId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"uri": "string",

  

  

"redirectType": "string",

  

  

"clientAppId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

ClientAppRequestUri

Operations

GET/api/management/v2/ClientAppRequestUri/clientapp/{clientAppId}GET/api/management/v2/ClientAppRequestUriPOST/api/management/v2/ClientAppRequestUriGET/api/management/v2/ClientAppRequestUri/{id}PUT/api/management/v2/ClientAppRequestUri/{id}DELETE/api/management/v2/ClientAppRequestUri/{id}PATCH/api/management/v2/ClientAppRequestUri/{id}PUT/api/management/v2/ClientAppRequestUri/batchPOST/api/management/v2/ClientAppRequestUri/batchDELETE/api/management/v2/ClientAppRequestUri/batch

---

GetClientAppRequestUriByClientAppId

GET

/api/management/v2/ClientAppRequestUri/clientapp/{clientAppId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"uri": "string",

  

  

"clientAppId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

GetClientAppRequestUris

GET

/api/management/v2/ClientAppRequestUri

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"uri": "string",

  

  

"clientAppId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateClientAppRequestUri

POST

/api/management/v2/ClientAppRequestUri

Request Body

{

  

"id": "string",

  

"uri": "string",

  

"clientAppId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"uri": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

GetClientAppRequestUri

GET

/api/management/v2/ClientAppRequestUri/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"uri": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

UpdateClientAppRequestUri

PUT

/api/management/v2/ClientAppRequestUri/{id}

Request Body

{

  

"id": "string",

  

"uri": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"uri": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

DeleteClientAppRequestUri

DELETE

/api/management/v2/ClientAppRequestUri/{id}

Responses

No Content

---

PatchClientAppRequestUri

PATCH

/api/management/v2/ClientAppRequestUri/{id}

Request Body

{

  

"uri": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"uri": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

UpdateClientAppRequestUris

PUT

/api/management/v2/ClientAppRequestUri/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"uri": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateClientAppRequestUris

POST

/api/management/v2/ClientAppRequestUri/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"uri": "string",

  

  

"clientAppId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteClientAppRequestUris

DELETE

/api/management/v2/ClientAppRequestUri/batch

Request Body

[

  

"string"

]

Responses

No Content

---

ClientAppResource

Operations

GET/api/management/v2/ClientAppResourcePOST/api/management/v2/ClientAppResourcePUT/api/management/v2/ClientAppResource/batchPOST/api/management/v2/ClientAppResource/batchDELETE/api/management/v2/ClientAppResource/batchGET/api/management/v2/ClientAppResource/{id}PUT/api/management/v2/ClientAppResource/{id}DELETE/api/management/v2/ClientAppResource/{id}PATCH/api/management/v2/ClientAppResource/{id}GET/api/management/v2/ClientAppResource/clientapp/{clientAppId}

---

GetClientAppResources

GET

/api/management/v2/ClientAppResource

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"key": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"clientAppId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateClientAppResource

POST

/api/management/v2/ClientAppResource

Request Body

{

  

"id": "string",

  

"key": "string",

  

"name": "string",

  

"description": "string",

  

"clientAppId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"key": "string",

  

"name": "string",

  

"description": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

UpdateClientAppResourceBatch

PUT

/api/management/v2/ClientAppResource/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"key": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateClientAppResourceBatch

POST

/api/management/v2/ClientAppResource/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"key": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"clientAppId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteClientAppResourceBatch

DELETE

/api/management/v2/ClientAppResource/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetClientAppResource

GET

/api/management/v2/ClientAppResource/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"key": "string",

  

"name": "string",

  

"description": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

UpdateClientAppResource

PUT

/api/management/v2/ClientAppResource/{id}

Request Body

{

  

"id": "string",

  

"key": "string",

  

"name": "string",

  

"description": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"key": "string",

  

"name": "string",

  

"description": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

DeleteClientAppResource

DELETE

/api/management/v2/ClientAppResource/{id}

Responses

No Content

---

PatchClientAppResource

PATCH

/api/management/v2/ClientAppResource/{id}

Request Body

{

  

"key": null,

  

"name": null,

  

"description": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"key": "string",

  

"name": "string",

  

"description": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

GetClientAppResourcesByClientAppId

GET

/api/management/v2/ClientAppResource/clientapp/{clientAppId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"key": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"clientAppId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

ClientAppRole

Operations

GET/api/management/v2/ClientAppRolePOST/api/management/v2/ClientAppRolePUT/api/management/v2/ClientAppRole/batchPOST/api/management/v2/ClientAppRole/batchDELETE/api/management/v2/ClientAppRole/batchGET/api/management/v2/ClientAppRole/{id}PUT/api/management/v2/ClientAppRole/{id}DELETE/api/management/v2/ClientAppRole/{id}PATCH/api/management/v2/ClientAppRole/{id}GET/api/management/v2/ClientAppRole/clientapp/{clientAppId}

---

GetClientAppRoles

GET

/api/management/v2/ClientAppRole

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"roleType": "string",

  

  

"applyToTenantId": "string",

  

  

"applyToIdpInstanceId": "string",

  

  

"clientAppId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateClientAppRole

POST

/api/management/v2/ClientAppRole

Request Body

{

  

"id": "string",

  

"roleType": "string",

  

"applyToTenantId": "string",

  

"applyToIdpInstanceId": "string",

  

"clientAppId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"roleType": "string",

  

"applyToTenantId": "string",

  

"applyToIdpInstanceId": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

UpdateClientAppRoleBatch

PUT

/api/management/v2/ClientAppRole/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"roleType": "string",

  

  

"applyToTenantId": "string",

  

  

"applyToIdpInstanceId": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateClientAppRoleBatch

POST

/api/management/v2/ClientAppRole/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"roleType": "string",

  

  

"applyToTenantId": "string",

  

  

"applyToIdpInstanceId": "string",

  

  

"clientAppId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteClientAppRoleBatch

DELETE

/api/management/v2/ClientAppRole/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetClientAppRole

GET

/api/management/v2/ClientAppRole/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"roleType": "string",

  

"applyToTenantId": "string",

  

"applyToIdpInstanceId": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

UpdateClientAppRole

PUT

/api/management/v2/ClientAppRole/{id}

Request Body

{

  

"id": "string",

  

"roleType": "string",

  

"applyToTenantId": "string",

  

"applyToIdpInstanceId": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"roleType": "string",

  

"applyToTenantId": "string",

  

"applyToIdpInstanceId": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

DeleteClientAppRole

DELETE

/api/management/v2/ClientAppRole/{id}

Responses

No Content

---

PatchClientAppRole

PATCH

/api/management/v2/ClientAppRole/{id}

Request Body

{

  

"roleType": null,

  

"applyToTenantId": null,

  

"applyToIdpInstanceId": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"roleType": "string",

  

"applyToTenantId": "string",

  

"applyToIdpInstanceId": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

GetClientAppRolesByClientAppId

GET

/api/management/v2/ClientAppRole/clientapp/{clientAppId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"roleType": "string",

  

  

"applyToTenantId": "string",

  

  

"applyToIdpInstanceId": "string",

  

  

"clientAppId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

ClientAppScope

Operations

GET/api/management/v2/ClientAppScopePOST/api/management/v2/ClientAppScopePUT/api/management/v2/ClientAppScope/batchPOST/api/management/v2/ClientAppScope/batchDELETE/api/management/v2/ClientAppScope/batchGET/api/management/v2/ClientAppScope/{id}PUT/api/management/v2/ClientAppScope/{id}DELETE/api/management/v2/ClientAppScope/{id}PATCH/api/management/v2/ClientAppScope/{id}GET/api/management/v2/ClientAppScope/clientapp/{clientAppId}

---

GetClientAppScopes

GET

/api/management/v2/ClientAppScope

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"key": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"clientAppId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateClientAppScope

POST

/api/management/v2/ClientAppScope

Request Body

{

  

"id": "string",

  

"key": "string",

  

"name": "string",

  

"description": "string",

  

"clientAppId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"key": "string",

  

"name": "string",

  

"description": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

UpdateClientAppScopeBatch

PUT

/api/management/v2/ClientAppScope/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"key": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateClientAppScopeBatch

POST

/api/management/v2/ClientAppScope/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"key": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"clientAppId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteClientAppScopeBatch

DELETE

/api/management/v2/ClientAppScope/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetClientAppScope

GET

/api/management/v2/ClientAppScope/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"key": "string",

  

"name": "string",

  

"description": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

UpdateClientAppScope

PUT

/api/management/v2/ClientAppScope/{id}

Request Body

{

  

"id": "string",

  

"key": "string",

  

"name": "string",

  

"description": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"key": "string",

  

"name": "string",

  

"description": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

DeleteClientAppScope

DELETE

/api/management/v2/ClientAppScope/{id}

Responses

No Content

---

PatchClientAppScope

PATCH

/api/management/v2/ClientAppScope/{id}

Request Body

{

  

"key": null,

  

"name": null,

  

"description": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"key": "string",

  

"name": "string",

  

"description": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

GetClientAppScopesByClientAppId

GET

/api/management/v2/ClientAppScope/clientapp/{clientAppId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"key": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"clientAppId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

ClientAppSecret

Operations

GET/api/management/v2/ClientAppSecretPOST/api/management/v2/ClientAppSecretPUT/api/management/v2/ClientAppSecret/batchPOST/api/management/v2/ClientAppSecret/batchDELETE/api/management/v2/ClientAppSecret/batchGET/api/management/v2/ClientAppSecret/{id}PUT/api/management/v2/ClientAppSecret/{id}DELETE/api/management/v2/ClientAppSecret/{id}PATCH/api/management/v2/ClientAppSecret/{id}GET/api/management/v2/ClientAppSecret/clientapp/{clientAppId}

---

GetClientAppSecrets

GET

/api/management/v2/ClientAppSecret

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"secret": "string",

  

  

"expiry": "string",

  

  

"clientAppId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateClientAppSecret

POST

/api/management/v2/ClientAppSecret

Request Body

{

  

"id": "string",

  

"name": "string",

  

"secret": "string",

  

"expiry": "string",

  

"clientAppId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"secret": "string",

  

"expiry": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

UpdateClientAppSecretBatch

PUT

/api/management/v2/ClientAppSecret/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"expiry": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateClientAppSecretBatch

POST

/api/management/v2/ClientAppSecret/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"secret": "string",

  

  

"expiry": "string",

  

  

"clientAppId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteClientAppSecretBatch

DELETE

/api/management/v2/ClientAppSecret/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetClientAppSecret

GET

/api/management/v2/ClientAppSecret/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"secret": "string",

  

"expiry": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

UpdateClientAppSecret

PUT

/api/management/v2/ClientAppSecret/{id}

Request Body

{

  

"id": "string",

  

"name": "string",

  

"expiry": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"secret": "string",

  

"expiry": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

DeleteClientAppSecret

DELETE

/api/management/v2/ClientAppSecret/{id}

Responses

No Content

---

PatchClientAppSecret

PATCH

/api/management/v2/ClientAppSecret/{id}

Request Body

{

  

"name": null,

  

"expiry": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"secret": "string",

  

"expiry": "string",

  

"clientAppId": "string",

  

"concurrencyToken": "string"

}

---

GetClientAppSecretsByClientAppId

GET

/api/management/v2/ClientAppSecret/clientapp/{clientAppId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"secret": "string",

  

  

"expiry": "string",

  

  

"clientAppId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CustomAsset

Operations

GET/api/management/v2/CustomAsset/{id}PUT/api/management/v2/CustomAsset/{id}DELETE/api/management/v2/CustomAsset/{id}PATCH/api/management/v2/CustomAsset/{id}GET/api/management/v2/CustomAssetPOST/api/management/v2/CustomAssetPUT/api/management/v2/CustomAsset/batchPOST/api/management/v2/CustomAsset/batchDELETE/api/management/v2/CustomAsset/batchPOST/api/management/v2/CustomAsset/createGET/api/management/v2/CustomAsset/mimetypes

---

GetCustomAsset

GET

/api/management/v2/CustomAsset/{id}

Responses

OK

Content-Type

application/json

{

  

"location": "string",

  

"mimetype": "string",

  

"data": "string",

  

"size": 0,

  

"fileName": "string",

  

"concurrencyToken": "string"

}

---

UpdateCustomAsset

PUT

/api/management/v2/CustomAsset/{id}

Request Body

{

  

"location": "string",

  

"mimetype": "string",

  

"data": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"location": "string",

  

"mimetype": "string",

  

"data": "string",

  

"size": 0,

  

"fileName": "string",

  

"concurrencyToken": "string"

}

---

DeleteCustomAsset

DELETE

/api/management/v2/CustomAsset/{id}

Responses

No Content

---

PatchCustomAsset

PATCH

/api/management/v2/CustomAsset/{id}

Request Body

{

  

"mimetype": "string",

  

"data": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"location": "string",

  

"mimetype": "string",

  

"data": "string",

  

"size": 0,

  

"fileName": "string",

  

"concurrencyToken": "string"

}

---

GetCustomAssets

GET

/api/management/v2/CustomAsset

Responses

OK

Content-Type

application/json

[

  

{

  

  

"location": "string",

  

  

"mimetype": "string",

  

  

"data": "string",

  

  

"size": 0,

  

  

"fileName": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateCustomAsset

POST

/api/management/v2/CustomAsset

Request Body

{

  

"location": "string",

  

"mimetype": "string",

  

"data": "string"

}

Responses

Created

Content-Type

application/json

{

  

"location": "string",

  

"mimetype": "string",

  

"data": "string",

  

"size": 0,

  

"fileName": "string",

  

"concurrencyToken": "string"

}

---

UpdateCustomAssetBatch

PUT

/api/management/v2/CustomAsset/batch

Request Body

[

  

{

  

  

"location": "string",

  

  

"mimetype": "string",

  

  

"data": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateCustomAssetBatch

POST

/api/management/v2/CustomAsset/batch

Request Body

[

  

{

  

  

"location": "string",

  

  

"mimetype": "string",

  

  

"data": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteCustomAssetBatch

DELETE

/api/management/v2/CustomAsset/batch

Request Body

[

  

"string"

]

Responses

No Content

---

CreateCustomAssetByExpander

POST

/api/management/v2/CustomAsset/create

Request Body

{

  

"mimetype": "string",

  

"assetFileName": "string",

  

"data": "string",

  

"applyToType": "string",

  

"tenantId": "string",

  

"clientAppId": "string",

  

"subscriptionId": "string",

  

"location": "string"

}

Responses

Created

Content-Type

application/json

{

  

"location": "string",

  

"mimetype": "string",

  

"data": "string",

  

"size": 0,

  

"fileName": "string",

  

"concurrencyToken": "string"

}

---

GetSupportedMimetypes

GET

/api/management/v2/CustomAsset/mimetypes

Responses

OK

Content-Type

application/json

[

]

---

Customer

Operations

GET/api/management/v2/CustomerPOST/api/management/v2/CustomerPUT/api/management/v2/Customer/batchPOST/api/management/v2/Customer/batchDELETE/api/management/v2/Customer/batchGET/api/management/v2/Customer/{id}PUT/api/management/v2/Customer/{id}DELETE/api/management/v2/Customer/{id}PATCH/api/management/v2/Customer/{id}

---

GetCustomers

GET

/api/management/v2/Customer

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"address": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateCustomer

POST

/api/management/v2/Customer

Request Body

{

  

"id": "string",

  

"name": "string",

  

"address": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"address": "string",

  

"concurrencyToken": "string"

}

---

UpdateCustomerBatch

PUT

/api/management/v2/Customer/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"address": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateCustomerBatch

POST

/api/management/v2/Customer/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"address": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteCustomerBatch

DELETE

/api/management/v2/Customer/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetCustomer

GET

/api/management/v2/Customer/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"address": "string",

  

"concurrencyToken": "string"

}

---

UpdateCustomer

PUT

/api/management/v2/Customer/{id}

Request Body

{

  

"id": "string",

  

"name": "string",

  

"address": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"address": "string",

  

"concurrencyToken": "string"

}

---

DeleteCustomer

DELETE

/api/management/v2/Customer/{id}

Responses

No Content

---

PatchCustomer

PATCH

/api/management/v2/Customer/{id}

Request Body

{

  

"name": "string",

  

"address": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"address": "string",

  

"concurrencyToken": "string"

}

---

CustomView

Operations

GET/api/management/v2/CustomView/{id}PUT/api/management/v2/CustomView/{id}DELETE/api/management/v2/CustomView/{id}PATCH/api/management/v2/CustomView/{id}GET/api/management/v2/CustomViewPOST/api/management/v2/CustomViewPUT/api/management/v2/CustomView/batchPOST/api/management/v2/CustomView/batchDELETE/api/management/v2/CustomView/batchPOST/api/management/v2/CustomView/viewtemplate/viewGET/api/management/v2/CustomView/viewtemplate/namesGET/api/management/v2/CustomView/viewtemplate/content/{viewName}

---

GetCustomView

GET

/api/management/v2/CustomView/{id}

Responses

OK

Content-Type

application/json

{

  

"location": "string",

  

"content": "string",

  

"concurrencyToken": "string"

}

---

UpdateCustomView

PUT

/api/management/v2/CustomView/{id}

Request Body

{

  

"location": "string",

  

"content": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"location": "string",

  

"content": "string",

  

"concurrencyToken": "string"

}

---

DeleteCustomView

DELETE

/api/management/v2/CustomView/{id}

Responses

No Content

---

PatchCustomView

PATCH

/api/management/v2/CustomView/{id}

Request Body

{

  

"content": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"location": "string",

  

"content": "string",

  

"concurrencyToken": "string"

}

---

GetCustomViews

GET

/api/management/v2/CustomView

Responses

OK

Content-Type

application/json

[

  

{

  

  

"location": "string",

  

  

"content": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateCustomView

POST

/api/management/v2/CustomView

Request Body

{

  

"location": "string",

  

"content": "string"

}

Responses

Created

Content-Type

application/json

{

  

"location": "string",

  

"content": "string",

  

"concurrencyToken": "string"

}

---

UpdateCustomViewBatch

PUT

/api/management/v2/CustomView/batch

Request Body

[

  

{

  

  

"location": "string",

  

  

"content": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateCustomViewBatch

POST

/api/management/v2/CustomView/batch

Request Body

[

  

{

  

  

"location": "string",

  

  

"content": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteBatch

DELETE

/api/management/v2/CustomView/batch

Request Body

[

]

Responses

No Content

---

CreateCustomViewFromTemplate

POST

/api/management/v2/CustomView/viewtemplate/view

Request Body

{

  

"viewName": "string",

  

"applyToType": "string",

  

"tenantId": "string",

  

"clientAppId": "string",

  

"subscriptionId": "string",

  

"location": "string"

}

Responses

Created

Content-Type

application/json

{

  

"location": "string",

  

"content": "string",

  

"concurrencyToken": "string"

}

---

GetAllTemplateViews

GET

/api/management/v2/CustomView/viewtemplate/names

Responses

OK

Content-Type

application/json

[

]

---

GetTemplateViewContent

GET

/api/management/v2/CustomView/viewtemplate/content/{viewName}

Responses

OK

Content-Type

application/json

"string"

---

EffectivePermissions

Operations

GET/api/management/v2/EffectivePermissions/proauthuser/{principalId}GET/api/management/v2/EffectivePermissions/proauthgroup/{principalId}GET/api/management/v2/EffectivePermissions/clientapp/{principalId}

---

GetForUser

GET

/api/management/v2/EffectivePermissions/proauthuser/{principalId}

Responses

OK

Content-Type

{

  

"principalId": "string",

  

"principalType": "string",

  

"scope": "string",

  

"assignments": [

  

  

{...}

  

],

  

"permissions": [

  

  

{...}

  

]

}

---

GetForGroup

GET

/api/management/v2/EffectivePermissions/proauthgroup/{principalId}

Responses

OK

Content-Type

{

  

"principalId": "string",

  

"principalType": "string",

  

"scope": "string",

  

"assignments": [

  

  

{...}

  

],

  

"permissions": [

  

  

{...}

  

]

}

---

GetForClientApp

GET

/api/management/v2/EffectivePermissions/clientapp/{principalId}

Responses

OK

Content-Type

{

  

"principalId": "string",

  

"principalType": "string",

  

"scope": "string",

  

"assignments": [

  

  

{...}

  

],

  

"permissions": [

  

  

{...}

  

]

}

---

FidoMetadataTrust

Operations

GET/api/management/v2/passkey-trust/mdsPOST/api/management/v2/passkey-trust/mds/refreshPOST/api/management/v2/passkey-trust/mds/signed-offline-import

---

GetStatus

GET

/api/management/v2/passkey-trust/mds

Responses

OK

Content-Type

{

  

"hasLastKnownGoodSnapshot": true,

  

"snapshotNumber": null,

  

"snapshotVersion": "string",

  

"refreshedOn": "string",

  

"nextUpdateOn": "string",

  

"entryCount": 0,

  

"lastRefreshError": "string"

}

---

RefreshFidoMetadataTrust

POST

/api/management/v2/passkey-trust/mds/refresh

Responses

OK

Content-Type

{

  

"hasLastKnownGoodSnapshot": true,

  

"snapshotNumber": null,

  

"snapshotVersion": "string",

  

"refreshedOn": "string",

  

"nextUpdateOn": "string",

  

"entryCount": 0,

  

"lastRefreshError": "string"

}

---

ImportFidoMetadataTrust

POST

/api/management/v2/passkey-trust/mds/signed-offline-import

Request Body

{

  

"signedBlobJwt": "string"

}

Responses

OK

Content-Type

{

  

"hasLastKnownGoodSnapshot": true,

  

"snapshotNumber": null,

  

"snapshotVersion": "string",

  

"refreshedOn": "string",

  

"nextUpdateOn": "string",

  

"entryCount": 0,

  

"lastRefreshError": "string"

}

---

IdentityReplacement

Operations

GET/api/management/v2/identity-replacementsPOST/api/management/v2/identity-replacementsGET/api/management/v2/identity-replacements/{id}GET/api/management/v2/identity-replacements/queuePOST/api/management/v2/identity-replacements/{id}/approvalsPOST/api/management/v2/identity-replacements/{id}/executePOST/api/management/v2/identity-replacements/{id}/cancel

---

GetIdentityReplacements

GET

/api/management/v2/identity-replacements

Responses

OK

Content-Type

[

  

{

  

  

"id": "string",

  

  

"proAuthUserId": "string",

  

  

"currentIdentityId": "string",

  

  

"replacementIdentityId": "string",

  

  

"status": "string",

  

  

"requestedByActorId": "string",

  

  

"reason": "string",

  

  

"requiredApprovals": 0,

  

  

"approvedByActorIds": [...],

  

  

"requestedOn": "string",

  

  

"expiresOn": "string",

  

  

"currentIdentityProvenOn": "string",

  

  

"replacementIdentityProvenOn": "string",

  

  

"approvalSatisfiedOn": "string",

  

  

"executedOn": "string",

  

  

"revocationCompletedOn": "string",

  

  

"revocationAttempts": 0,

  

  

"policyFingerprint": "string",

  

  

"currentIdentity": {...},

  

  

"replacementIdentity": {...}

  

}

]

---

RequestReplacement

POST

/api/management/v2/identity-replacements

Request Body

{

  

"proAuthUserId": "string",

  

"replacementIdpInstanceId": "string",

  

"replacementUniqueUserId": "string",

  

"replacementIssuer": "string",

  

"replacementSubject": "string",

  

"isUserStoreIdentity": true,

  

"reason": "string",

  

"policyFingerprint": "string",

  

"requiredApprovals": 0,

  

"lifetimeMinutes": 0

}

Responses

Created

Content-Type

{

  

"id": "string",

  

"proAuthUserId": "string",

  

"currentIdentityId": "string",

  

"replacementIdentityId": "string",

  

"status": "string",

  

"requestedByActorId": "string",

  

"reason": "string",

  

"requiredApprovals": 0,

  

"approvedByActorIds": [

  

  

"string"

  

],

  

"requestedOn": "string",

  

"expiresOn": "string",

  

"currentIdentityProvenOn": "string",

  

"replacementIdentityProvenOn": "string",

  

"approvalSatisfiedOn": "string",

  

"executedOn": "string",

  

"revocationCompletedOn": "string",

  

"revocationAttempts": 0,

  

"policyFingerprint": "string",

  

"currentIdentity": {

  

  

"id": "string",

  

  

"idpInstanceId": "string",

  

  

"issuer": "string",

  

  

"subject": "string",

  

  

"isUserStoreIdentity": true,

  

  

"lifecycleStatus": "string"

  

},

  

"replacementIdentity": {

  

  

"id": "string",

  

  

"idpInstanceId": "string",

  

  

"issuer": "string",

  

  

"subject": "string",

  

  

"isUserStoreIdentity": true,

  

  

"lifecycleStatus": "string"

  

}

}

---

GetIdentityReplacement

GET

/api/management/v2/identity-replacements/{id}

Responses

OK

Content-Type

{

  

"id": "string",

  

"proAuthUserId": "string",

  

"currentIdentityId": "string",

  

"replacementIdentityId": "string",

  

"status": "string",

  

"requestedByActorId": "string",

  

"reason": "string",

  

"requiredApprovals": 0,

  

"approvedByActorIds": [

  

  

"string"

  

],

  

"requestedOn": "string",

  

"expiresOn": "string",

  

"currentIdentityProvenOn": "string",

  

"replacementIdentityProvenOn": "string",

  

"approvalSatisfiedOn": "string",

  

"executedOn": "string",

  

"revocationCompletedOn": "string",

  

"revocationAttempts": 0,

  

"policyFingerprint": "string",

  

"currentIdentity": {

  

  

"id": "string",

  

  

"idpInstanceId": "string",

  

  

"issuer": "string",

  

  

"subject": "string",

  

  

"isUserStoreIdentity": true,

  

  

"lifecycleStatus": "string"

  

},

  

"replacementIdentity": {

  

  

"id": "string",

  

  

"idpInstanceId": "string",

  

  

"issuer": "string",

  

  

"subject": "string",

  

  

"isUserStoreIdentity": true,

  

  

"lifecycleStatus": "string"

  

}

}

---

ListIdentityReplacements

GET

/api/management/v2/identity-replacements/queue

Responses

OK

Content-Type

{

  

"items": [

  

  

{...}

  

],

  

"totalCount": 0

}

---

ApproveIdentityReplacement

POST

/api/management/v2/identity-replacements/{id}/approvals

Responses

OK

Content-Type

{

  

"id": "string",

  

"proAuthUserId": "string",

  

"currentIdentityId": "string",

  

"replacementIdentityId": "string",

  

"status": "string",

  

"requestedByActorId": "string",

  

"reason": "string",

  

"requiredApprovals": 0,

  

"approvedByActorIds": [

  

  

"string"

  

],

  

"requestedOn": "string",

  

"expiresOn": "string",

  

"currentIdentityProvenOn": "string",

  

"replacementIdentityProvenOn": "string",

  

"approvalSatisfiedOn": "string",

  

"executedOn": "string",

  

"revocationCompletedOn": "string",

  

"revocationAttempts": 0,

  

"policyFingerprint": "string",

  

"currentIdentity": {

  

  

"id": "string",

  

  

"idpInstanceId": "string",

  

  

"issuer": "string",

  

  

"subject": "string",

  

  

"isUserStoreIdentity": true,

  

  

"lifecycleStatus": "string"

  

},

  

"replacementIdentity": {

  

  

"id": "string",

  

  

"idpInstanceId": "string",

  

  

"issuer": "string",

  

  

"subject": "string",

  

  

"isUserStoreIdentity": true,

  

  

"lifecycleStatus": "string"

  

}

}

---

Execute

POST

/api/management/v2/identity-replacements/{id}/execute

Responses

OK

Content-Type

{

  

"id": "string",

  

"proAuthUserId": "string",

  

"currentIdentityId": "string",

  

"replacementIdentityId": "string",

  

"status": "string",

  

"requestedByActorId": "string",

  

"reason": "string",

  

"requiredApprovals": 0,

  

"approvedByActorIds": [

  

  

"string"

  

],

  

"requestedOn": "string",

  

"expiresOn": "string",

  

"currentIdentityProvenOn": "string",

  

"replacementIdentityProvenOn": "string",

  

"approvalSatisfiedOn": "string",

  

"executedOn": "string",

  

"revocationCompletedOn": "string",

  

"revocationAttempts": 0,

  

"policyFingerprint": "string",

  

"currentIdentity": {

  

  

"id": "string",

  

  

"idpInstanceId": "string",

  

  

"issuer": "string",

  

  

"subject": "string",

  

  

"isUserStoreIdentity": true,

  

  

"lifecycleStatus": "string"

  

},

  

"replacementIdentity": {

  

  

"id": "string",

  

  

"idpInstanceId": "string",

  

  

"issuer": "string",

  

  

"subject": "string",

  

  

"isUserStoreIdentity": true,

  

  

"lifecycleStatus": "string"

  

}

}

---

CancelIdentityReplacement

POST

/api/management/v2/identity-replacements/{id}/cancel

Responses

OK

Content-Type

{

  

"id": "string",

  

"proAuthUserId": "string",

  

"currentIdentityId": "string",

  

"replacementIdentityId": "string",

  

"status": "string",

  

"requestedByActorId": "string",

  

"reason": "string",

  

"requiredApprovals": 0,

  

"approvedByActorIds": [

  

  

"string"

  

],

  

"requestedOn": "string",

  

"expiresOn": "string",

  

"currentIdentityProvenOn": "string",

  

"replacementIdentityProvenOn": "string",

  

"approvalSatisfiedOn": "string",

  

"executedOn": "string",

  

"revocationCompletedOn": "string",

  

"revocationAttempts": 0,

  

"policyFingerprint": "string",

  

"currentIdentity": {

  

  

"id": "string",

  

  

"idpInstanceId": "string",

  

  

"issuer": "string",

  

  

"subject": "string",

  

  

"isUserStoreIdentity": true,

  

  

"lifecycleStatus": "string"

  

},

  

"replacementIdentity": {

  

  

"id": "string",

  

  

"idpInstanceId": "string",

  

  

"issuer": "string",

  

  

"subject": "string",

  

  

"isUserStoreIdentity": true,

  

  

"lifecycleStatus": "string"

  

}

}

---

IdpInstance

Operations

GET/api/management/v2/IdpInstancePOST/api/management/v2/IdpInstancePUT/api/management/v2/IdpInstance/batchPOST/api/management/v2/IdpInstance/batchDELETE/api/management/v2/IdpInstance/batchGET/api/management/v2/IdpInstance/{id}PUT/api/management/v2/IdpInstance/{id}DELETE/api/management/v2/IdpInstance/{id}PATCH/api/management/v2/IdpInstance/{id}GET/api/management/v2/IdpInstance/tenant/{tenantId}/clientapp/{clientAppId}GET/api/management/v2/IdpInstance/tenant/{tenantId}GET/api/management/v2/IdpInstance/subscription/{subscriptionId}POST/api/management/v2/IdpInstance/{idpInstance}/scim/tokenGET/api/management/v2/IdpInstance/{idpInstance}/healthPUT/api/management/v2/IdpInstance/{id}/tenantsPOST/api/management/v2/IdpInstance/{id}/tenantsDELETE/api/management/v2/IdpInstance/{id}/tenantsPUT/api/management/v2/IdpInstance/{id}/certstoresPOST/api/management/v2/IdpInstance/{id}/certstoresDELETE/api/management/v2/IdpInstance/{id}/certstoresPUT/api/management/v2/IdpInstance/{id}/clientappsPOST/api/management/v2/IdpInstance/{id}/clientappsDELETE/api/management/v2/IdpInstance/{id}/clientappsPUT/api/management/v2/IdpInstance/{id}/mfainstancesPOST/api/management/v2/IdpInstance/{id}/mfainstancesDELETE/api/management/v2/IdpInstance/{id}/mfainstances

---

GetIdpInstances

GET

/api/management/v2/IdpInstance

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"position": 0,

  

  

"isActive": true,

  

  

"treatMfaFactorClaimsAsConfirmed": true,

  

  

"autoCreateProAuthUser": true,

  

  

"isHidden": true,

  

  

"idpTypeId": "string",

  

  

"subscriptionId": "string",

  

  

"idpFactoryType": "string",

  

  

"hasConfigurationError": true,

  

  

"mfaInstances": "[Circular Reference]",

  

  

"tenants": "[Circular Reference]",

  

  

"clientApps": "[Circular Reference]",

  

  

"certStores": [...],

  

  

"options": [...],

  

  

"concurrencyToken": "string"

  

}

]

---

CreateIdpInstance

POST

/api/management/v2/IdpInstance

Request Body

{

  

"id": "string",

  

"name": "string",

  

"position": 0,

  

"isActive": true,

  

"treatMfaFactorClaimsAsConfirmed": true,

  

"autoCreateProAuthUser": true,

  

"isHidden": true,

  

"idpTypeId": "string",

  

"subscriptionId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"position": 0,

  

"isActive": true,

  

"treatMfaFactorClaimsAsConfirmed": true,

  

"autoCreateProAuthUser": true,

  

"isHidden": true,

  

"idpTypeId": "string",

  

"subscriptionId": "string",

  

"idpFactoryType": "string",

  

"hasConfigurationError": true,

  

"mfaInstances": "[Circular Reference]",

  

"tenants": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"certStores": [

  

  

{...}

  

],

  

"options": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

UpdateIdpInstanceBatch

PUT

/api/management/v2/IdpInstance/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"position": 0,

  

  

"isActive": true,

  

  

"treatMfaFactorClaimsAsConfirmed": true,

  

  

"autoCreateProAuthUser": true,

  

  

"isHidden": true,

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateIdpInstanceBatch

POST

/api/management/v2/IdpInstance/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"position": 0,

  

  

"isActive": true,

  

  

"treatMfaFactorClaimsAsConfirmed": true,

  

  

"autoCreateProAuthUser": true,

  

  

"isHidden": true,

  

  

"idpTypeId": "string",

  

  

"subscriptionId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteIdpInstanceBatch

DELETE

/api/management/v2/IdpInstance/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetIdpInstance

GET

/api/management/v2/IdpInstance/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"position": 0,

  

"isActive": true,

  

"treatMfaFactorClaimsAsConfirmed": true,

  

"autoCreateProAuthUser": true,

  

"isHidden": true,

  

"idpTypeId": "string",

  

"subscriptionId": "string",

  

"idpFactoryType": "string",

  

"hasConfigurationError": true,

  

"mfaInstances": "[Circular Reference]",

  

"tenants": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"certStores": [

  

  

{...}

  

],

  

"options": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

UpdateIdpInstance

PUT

/api/management/v2/IdpInstance/{id}

Request Body

{

  

"id": "string",

  

"name": "string",

  

"position": 0,

  

"isActive": true,

  

"treatMfaFactorClaimsAsConfirmed": true,

  

"autoCreateProAuthUser": true,

  

"isHidden": true,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"position": 0,

  

"isActive": true,

  

"treatMfaFactorClaimsAsConfirmed": true,

  

"autoCreateProAuthUser": true,

  

"isHidden": true,

  

"idpTypeId": "string",

  

"subscriptionId": "string",

  

"idpFactoryType": "string",

  

"hasConfigurationError": true,

  

"mfaInstances": "[Circular Reference]",

  

"tenants": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"certStores": [

  

  

{...}

  

],

  

"options": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

DeleteIdpInstance

DELETE

/api/management/v2/IdpInstance/{id}

Responses

No Content

---

PatchIdpInstance

PATCH

/api/management/v2/IdpInstance/{id}

Request Body

{

  

"name": null,

  

"position": null,

  

"isActive": null,

  

"treatMfaFactorClaimsAsConfirmed": null,

  

"autoCreateProAuthUser": null,

  

"isHidden": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"position": 0,

  

"isActive": true,

  

"treatMfaFactorClaimsAsConfirmed": true,

  

"autoCreateProAuthUser": true,

  

"isHidden": true,

  

"idpTypeId": "string",

  

"subscriptionId": "string",

  

"idpFactoryType": "string",

  

"hasConfigurationError": true,

  

"mfaInstances": "[Circular Reference]",

  

"tenants": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"certStores": [

  

  

{...}

  

],

  

"options": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

GetIdpInstancesByTenantAndClientApp

GET

/api/management/v2/IdpInstance/tenant/{tenantId}/clientapp/{clientAppId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"position": 0,

  

  

"isActive": true,

  

  

"treatMfaFactorClaimsAsConfirmed": true,

  

  

"autoCreateProAuthUser": true,

  

  

"isHidden": true,

  

  

"idpTypeId": "string",

  

  

"subscriptionId": "string",

  

  

"idpFactoryType": "string",

  

  

"hasConfigurationError": true,

  

  

"mfaInstances": "[Circular Reference]",

  

  

"tenants": "[Circular Reference]",

  

  

"clientApps": "[Circular Reference]",

  

  

"certStores": [...],

  

  

"options": [...],

  

  

"concurrencyToken": "string"

  

}

]

---

GetIdpInstancesByTenantId

GET

/api/management/v2/IdpInstance/tenant/{tenantId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"position": 0,

  

  

"isActive": true,

  

  

"treatMfaFactorClaimsAsConfirmed": true,

  

  

"autoCreateProAuthUser": true,

  

  

"isHidden": true,

  

  

"idpTypeId": "string",

  

  

"subscriptionId": "string",

  

  

"idpFactoryType": "string",

  

  

"hasConfigurationError": true,

  

  

"mfaInstances": "[Circular Reference]",

  

  

"tenants": "[Circular Reference]",

  

  

"clientApps": "[Circular Reference]",

  

  

"certStores": [...],

  

  

"options": [...],

  

  

"concurrencyToken": "string"

  

}

]

---

GetIdpInstancesBySubscription

GET

/api/management/v2/IdpInstance/subscription/{subscriptionId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"position": 0,

  

  

"isActive": true,

  

  

"treatMfaFactorClaimsAsConfirmed": true,

  

  

"autoCreateProAuthUser": true,

  

  

"isHidden": true,

  

  

"idpTypeId": "string",

  

  

"subscriptionId": "string",

  

  

"idpFactoryType": "string",

  

  

"hasConfigurationError": true,

  

  

"mfaInstances": "[Circular Reference]",

  

  

"tenants": "[Circular Reference]",

  

  

"clientApps": "[Circular Reference]",

  

  

"certStores": [...],

  

  

"options": [...],

  

  

"concurrencyToken": "string"

  

}

]

---

GenerateScimToken

POST

/api/management/v2/IdpInstance/{idpInstance}/scim/token

Responses

Bad Request

Content-Type

application/json

{

  

"type": "string",

  

"title": "string",

  

"status": null,

  

"detail": "string",

  

"instance": "string"

}

---

GetHealthStatus

GET

/api/management/v2/IdpInstance/{idpInstance}/health

Responses

OK

Content-Type

application/json

{

  

"instanceId": null,

  

"hasConfigurationError": true,

  

"isOperational": true

}

---

SetIdpInstanceTenants

PUT

/api/management/v2/IdpInstance/{id}/tenants

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"position": 0,

  

"isActive": true,

  

"treatMfaFactorClaimsAsConfirmed": true,

  

"autoCreateProAuthUser": true,

  

"isHidden": true,

  

"idpTypeId": "string",

  

"subscriptionId": "string",

  

"idpFactoryType": "string",

  

"hasConfigurationError": true,

  

"mfaInstances": "[Circular Reference]",

  

"tenants": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"certStores": [

  

  

{...}

  

],

  

"options": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

AddIdpInstanceTenant

POST

/api/management/v2/IdpInstance/{id}/tenants

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"position": 0,

  

"isActive": true,

  

"treatMfaFactorClaimsAsConfirmed": true,

  

"autoCreateProAuthUser": true,

  

"isHidden": true,

  

"idpTypeId": "string",

  

"subscriptionId": "string",

  

"idpFactoryType": "string",

  

"hasConfigurationError": true,

  

"mfaInstances": "[Circular Reference]",

  

"tenants": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"certStores": [

  

  

{...}

  

],

  

"options": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

RemoveIdpInstanceTenant

DELETE

/api/management/v2/IdpInstance/{id}/tenants

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"position": 0,

  

"isActive": true,

  

"treatMfaFactorClaimsAsConfirmed": true,

  

"autoCreateProAuthUser": true,

  

"isHidden": true,

  

"idpTypeId": "string",

  

"subscriptionId": "string",

  

"idpFactoryType": "string",

  

"hasConfigurationError": true,

  

"mfaInstances": "[Circular Reference]",

  

"tenants": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"certStores": [

  

  

{...}

  

],

  

"options": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

SetCertStores

PUT

/api/management/v2/IdpInstance/{id}/certstores

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"position": 0,

  

"isActive": true,

  

"treatMfaFactorClaimsAsConfirmed": true,

  

"autoCreateProAuthUser": true,

  

"isHidden": true,

  

"idpTypeId": "string",

  

"subscriptionId": "string",

  

"idpFactoryType": "string",

  

"hasConfigurationError": true,

  

"mfaInstances": "[Circular Reference]",

  

"tenants": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"certStores": [

  

  

{...}

  

],

  

"options": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

AddCertStore

POST

/api/management/v2/IdpInstance/{id}/certstores

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"position": 0,

  

"isActive": true,

  

"treatMfaFactorClaimsAsConfirmed": true,

  

"autoCreateProAuthUser": true,

  

"isHidden": true,

  

"idpTypeId": "string",

  

"subscriptionId": "string",

  

"idpFactoryType": "string",

  

"hasConfigurationError": true,

  

"mfaInstances": "[Circular Reference]",

  

"tenants": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"certStores": [

  

  

{...}

  

],

  

"options": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

RemoveCertStore

DELETE

/api/management/v2/IdpInstance/{id}/certstores

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"position": 0,

  

"isActive": true,

  

"treatMfaFactorClaimsAsConfirmed": true,

  

"autoCreateProAuthUser": true,

  

"isHidden": true,

  

"idpTypeId": "string",

  

"subscriptionId": "string",

  

"idpFactoryType": "string",

  

"hasConfigurationError": true,

  

"mfaInstances": "[Circular Reference]",

  

"tenants": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"certStores": [

  

  

{...}

  

],

  

"options": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

SetIdpInstanceClientApps

PUT

/api/management/v2/IdpInstance/{id}/clientapps

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"position": 0,

  

"isActive": true,

  

"treatMfaFactorClaimsAsConfirmed": true,

  

"autoCreateProAuthUser": true,

  

"isHidden": true,

  

"idpTypeId": "string",

  

"subscriptionId": "string",

  

"idpFactoryType": "string",

  

"hasConfigurationError": true,

  

"mfaInstances": "[Circular Reference]",

  

"tenants": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"certStores": [

  

  

{...}

  

],

  

"options": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

AddIdpInstanceClientApp

POST

/api/management/v2/IdpInstance/{id}/clientapps

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"position": 0,

  

"isActive": true,

  

"treatMfaFactorClaimsAsConfirmed": true,

  

"autoCreateProAuthUser": true,

  

"isHidden": true,

  

"idpTypeId": "string",

  

"subscriptionId": "string",

  

"idpFactoryType": "string",

  

"hasConfigurationError": true,

  

"mfaInstances": "[Circular Reference]",

  

"tenants": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"certStores": [

  

  

{...}

  

],

  

"options": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

RemoveIdpInstanceClientApp

DELETE

/api/management/v2/IdpInstance/{id}/clientapps

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"position": 0,

  

"isActive": true,

  

"treatMfaFactorClaimsAsConfirmed": true,

  

"autoCreateProAuthUser": true,

  

"isHidden": true,

  

"idpTypeId": "string",

  

"subscriptionId": "string",

  

"idpFactoryType": "string",

  

"hasConfigurationError": true,

  

"mfaInstances": "[Circular Reference]",

  

"tenants": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"certStores": [

  

  

{...}

  

],

  

"options": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

SetIdpInstanceMfaInstances

PUT

/api/management/v2/IdpInstance/{id}/mfainstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"position": 0,

  

"isActive": true,

  

"treatMfaFactorClaimsAsConfirmed": true,

  

"autoCreateProAuthUser": true,

  

"isHidden": true,

  

"idpTypeId": "string",

  

"subscriptionId": "string",

  

"idpFactoryType": "string",

  

"hasConfigurationError": true,

  

"mfaInstances": "[Circular Reference]",

  

"tenants": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"certStores": [

  

  

{...}

  

],

  

"options": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

AddIdpInstanceMfaInstance

POST

/api/management/v2/IdpInstance/{id}/mfainstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"position": 0,

  

"isActive": true,

  

"treatMfaFactorClaimsAsConfirmed": true,

  

"autoCreateProAuthUser": true,

  

"isHidden": true,

  

"idpTypeId": "string",

  

"subscriptionId": "string",

  

"idpFactoryType": "string",

  

"hasConfigurationError": true,

  

"mfaInstances": "[Circular Reference]",

  

"tenants": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"certStores": [

  

  

{...}

  

],

  

"options": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

RemoveIdpInstanceMfaInstance

DELETE

/api/management/v2/IdpInstance/{id}/mfainstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"position": 0,

  

"isActive": true,

  

"treatMfaFactorClaimsAsConfirmed": true,

  

"autoCreateProAuthUser": true,

  

"isHidden": true,

  

"idpTypeId": "string",

  

"subscriptionId": "string",

  

"idpFactoryType": "string",

  

"hasConfigurationError": true,

  

"mfaInstances": "[Circular Reference]",

  

"tenants": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"certStores": [

  

  

{...}

  

],

  

"options": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

IdpInstanceMetadata

Operations

GET/api/management/v2/IdpInstanceMetadata/{idpInstanceId}POST/api/management/v2/IdpInstanceMetadata/{idpInstanceId}GET/api/management/v2/IdpInstanceMetadata/{idpInstanceId}/{key}PUT/api/management/v2/IdpInstanceMetadata/{idpInstanceId}/{key}DELETE/api/management/v2/IdpInstanceMetadata/{idpInstanceId}/{key}PATCH/api/management/v2/IdpInstanceMetadata/{idpInstanceId}/{key}

---

GetIdpInstanceMetadataByIdpInstanceId

GET

/api/management/v2/IdpInstanceMetadata/{idpInstanceId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"idpInstanceId": null,

  

  

"key": "string",

  

  

"value": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateIdpInstanceMetadata

POST

/api/management/v2/IdpInstanceMetadata/{idpInstanceId}

Request Body

{

  

"idpInstanceId": "string",

  

"key": "string",

  

"value": "string"

}

Responses

OK

Content-Type

application/json

{

  

"idpInstanceId": null,

  

"key": "string",

  

"value": "string",

  

"concurrencyToken": "string"

}

---

GetIdpInstanceMetadata

GET

/api/management/v2/IdpInstanceMetadata/{idpInstanceId}/{key}

Responses

OK

Content-Type

application/json

{

  

"idpInstanceId": null,

  

"key": "string",

  

"value": "string",

  

"concurrencyToken": "string"

}

---

UpdateIdpInstanceMetadata

PUT

/api/management/v2/IdpInstanceMetadata/{idpInstanceId}/{key}

Request Body

{

  

"value": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"idpInstanceId": null,

  

"key": "string",

  

"value": "string",

  

"concurrencyToken": "string"

}

---

DeleteIdpInstanceMetadata

DELETE

/api/management/v2/IdpInstanceMetadata/{idpInstanceId}/{key}

Responses

Bad Request

Content-Type

application/json

{

  

"type": "string",

  

"title": "string",

  

"status": null,

  

"detail": "string",

  

"instance": "string"

}

---

PatchIdpInstanceMetadata

PATCH

/api/management/v2/IdpInstanceMetadata/{idpInstanceId}/{key}

Request Body

{

  

"value": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"idpInstanceId": null,

  

"key": "string",

  

"value": "string",

  

"concurrencyToken": "string"

}

---

IdpType

Operations

GET/api/management/v2/IdpType/{id}PUT/api/management/v2/IdpType/{id}PATCH/api/management/v2/IdpType/{id}PUT/api/management/v2/IdpType/batchGET/api/management/v2/IdpType/name/{name}GET/api/management/v2/IdpType

---

GetIdpType

GET

/api/management/v2/IdpType/{id}

Responses

OK

Content-Type

application/json

{

  

"id": null,

  

"name": "string",

  

"providerType": 0,

  

"factoryType": "string",

  

"isActive": true,

  

"concurrencyToken": "string"

}

---

UpdateIdpType

PUT

/api/management/v2/IdpType/{id}

Request Body

{

  

"id": "string",

  

"name": "string",

  

"providerType": "string",

  

"factoryType": "string",

  

"isActive": true,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": null,

  

"name": "string",

  

"providerType": 0,

  

"factoryType": "string",

  

"isActive": true,

  

"concurrencyToken": "string"

}

---

PatchIdpType

PATCH

/api/management/v2/IdpType/{id}

Request Body

{

  

"name": "string",

  

"providerType": "string",

  

"factoryType": "string",

  

"isActive": true,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": null,

  

"name": "string",

  

"providerType": 0,

  

"factoryType": "string",

  

"isActive": true,

  

"concurrencyToken": "string"

}

---

UpdateIdpTypeBatch

PUT

/api/management/v2/IdpType/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"providerType": "string",

  

  

"factoryType": "string",

  

  

"isActive": true,

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": null,

  

  

"name": "string",

  

  

"providerType": 0,

  

  

"factoryType": "string",

  

  

"isActive": true,

  

  

"concurrencyToken": "string"

  

}

]

---

GetIdpTypeByName

GET

/api/management/v2/IdpType/name/{name}

Responses

OK

Content-Type

application/json

{

  

"id": null,

  

"name": "string",

  

"providerType": 0,

  

"factoryType": "string",

  

"isActive": true,

  

"concurrencyToken": "string"

}

---

GetIdpTypes

GET

/api/management/v2/IdpType

Responses

OK

Content-Type

application/json

[

]

---

IpAddressRange

Operations

GET/api/management/v2/IpAddressRangePOST/api/management/v2/IpAddressRangePUT/api/management/v2/IpAddressRange/batchPOST/api/management/v2/IpAddressRange/batchDELETE/api/management/v2/IpAddressRange/batchGET/api/management/v2/IpAddressRange/{id}PUT/api/management/v2/IpAddressRange/{id}DELETE/api/management/v2/IpAddressRange/{id}PATCH/api/management/v2/IpAddressRange/{id}GET/api/management/v2/IpAddressRange/tenant/{tenantId}

---

GetIpAddressRanges

GET

/api/management/v2/IpAddressRange

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"lower": "string",

  

  

"upper": "string",

  

  

"tenantId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateIpAddressRange

POST

/api/management/v2/IpAddressRange

Request Body

{

  

"id": "string",

  

"lower": "string",

  

"upper": "string",

  

"tenantId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"lower": "string",

  

"upper": "string",

  

"tenantId": "string",

  

"concurrencyToken": "string"

}

---

UpdateIpAddressRangeBatch

PUT

/api/management/v2/IpAddressRange/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"lower": "string",

  

  

"upper": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateIpAddressRangeBatch

POST

/api/management/v2/IpAddressRange/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"lower": "string",

  

  

"upper": "string",

  

  

"tenantId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteIpAddressRangeBatch

DELETE

/api/management/v2/IpAddressRange/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetIpAddressRange

GET

/api/management/v2/IpAddressRange/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"lower": "string",

  

"upper": "string",

  

"tenantId": "string",

  

"concurrencyToken": "string"

}

---

UpdateIpAddressRange

PUT

/api/management/v2/IpAddressRange/{id}

Request Body

{

  

"id": "string",

  

"lower": "string",

  

"upper": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"lower": "string",

  

"upper": "string",

  

"tenantId": "string",

  

"concurrencyToken": "string"

}

---

DeleteIpAddressRange

DELETE

/api/management/v2/IpAddressRange/{id}

Responses

No Content

---

PatchIpAddressRange

PATCH

/api/management/v2/IpAddressRange/{id}

Request Body

{

  

"lower": null,

  

"upper": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"lower": "string",

  

"upper": "string",

  

"tenantId": "string",

  

"concurrencyToken": "string"

}

---

GetIpAddressRangesForTenantId

GET

/api/management/v2/IpAddressRange/tenant/{tenantId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"lower": "string",

  

  

"upper": "string",

  

  

"tenantId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

MfaInstance

Operations

GET/api/management/v2/MfaInstancePOST/api/management/v2/MfaInstancePUT/api/management/v2/MfaInstance/batchPOST/api/management/v2/MfaInstance/batchDELETE/api/management/v2/MfaInstance/batchGET/api/management/v2/MfaInstance/{id}PUT/api/management/v2/MfaInstance/{id}DELETE/api/management/v2/MfaInstance/{id}PATCH/api/management/v2/MfaInstance/{id}PUT/api/management/v2/MfaInstance/{id}/tenantsPOST/api/management/v2/MfaInstance/{id}/tenantsDELETE/api/management/v2/MfaInstance/{id}/tenantsPUT/api/management/v2/MfaInstance/{id}/idpinstancesPOST/api/management/v2/MfaInstance/{id}/idpinstancesDELETE/api/management/v2/MfaInstance/{id}/idpinstancesPUT/api/management/v2/MfaInstance/{id}/clientappsPOST/api/management/v2/MfaInstance/{id}/clientappsDELETE/api/management/v2/MfaInstance/{id}/clientappsPUT/api/management/v2/MfaInstance/{id}/idptypesPOST/api/management/v2/MfaInstance/{id}/idptypesDELETE/api/management/v2/MfaInstance/{id}/idptypesPUT/api/management/v2/MfaInstance/{id}/proauthusersPOST/api/management/v2/MfaInstance/{id}/proauthusersDELETE/api/management/v2/MfaInstance/{id}/proauthusers

---

GetMfaInstances

GET

/api/management/v2/MfaInstance

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"executionOrder": 0,

  

  

"isActive": true,

  

  

"mfaTypeId": "string",

  

  

"subscriptionId": "string",

  

  

"hasConfigurationError": true,

  

  

"clientApps": "[Circular Reference]",

  

  

"tenants": [...],

  

  

"idpInstances": [...],

  

  

"proAuthUsers": "[Circular Reference]",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateMfaInstance

POST

/api/management/v2/MfaInstance

Request Body

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"mfaTypeId": "string",

  

"subscriptionId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"mfaTypeId": "string",

  

"subscriptionId": "string",

  

"hasConfigurationError": true,

  

"clientApps": "[Circular Reference]",

  

"tenants": [

  

  

{...}

  

],

  

"idpInstances": [

  

],

  

"proAuthUsers": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

UpdateMfaInstanceBatch

PUT

/api/management/v2/MfaInstance/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"executionOrder": 0,

  

  

"isActive": true,

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateMfaInstanceBatch

POST

/api/management/v2/MfaInstance/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"executionOrder": 0,

  

  

"isActive": true,

  

  

"mfaTypeId": "string",

  

  

"subscriptionId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteMfaInstanceBatch

DELETE

/api/management/v2/MfaInstance/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetMfaInstance

GET

/api/management/v2/MfaInstance/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"mfaTypeId": "string",

  

"subscriptionId": "string",

  

"hasConfigurationError": true,

  

"clientApps": "[Circular Reference]",

  

"tenants": [

  

  

{...}

  

],

  

"idpInstances": [

  

],

  

"proAuthUsers": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

UpdateMfaInstance

PUT

/api/management/v2/MfaInstance/{id}

Request Body

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"mfaTypeId": "string",

  

"subscriptionId": "string",

  

"hasConfigurationError": true,

  

"clientApps": "[Circular Reference]",

  

"tenants": [

  

  

{...}

  

],

  

"idpInstances": [

  

],

  

"proAuthUsers": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

DeleteMfaInstance

DELETE

/api/management/v2/MfaInstance/{id}

Responses

No Content

---

PatchMfaInstance

PATCH

/api/management/v2/MfaInstance/{id}

Request Body

{

  

"name": null,

  

"executionOrder": null,

  

"isActive": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"mfaTypeId": "string",

  

"subscriptionId": "string",

  

"hasConfigurationError": true,

  

"clientApps": "[Circular Reference]",

  

"tenants": [

  

  

{...}

  

],

  

"idpInstances": [

  

],

  

"proAuthUsers": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

SetMfaInstanceTenants

PUT

/api/management/v2/MfaInstance/{id}/tenants

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"mfaTypeId": "string",

  

"subscriptionId": "string",

  

"hasConfigurationError": true,

  

"clientApps": "[Circular Reference]",

  

"tenants": [

  

  

{...}

  

],

  

"idpInstances": [

  

],

  

"proAuthUsers": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

AddMfaInstanceTenant

POST

/api/management/v2/MfaInstance/{id}/tenants

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"mfaTypeId": "string",

  

"subscriptionId": "string",

  

"hasConfigurationError": true,

  

"clientApps": "[Circular Reference]",

  

"tenants": [

  

  

{...}

  

],

  

"idpInstances": [

  

],

  

"proAuthUsers": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

RemoveMfaInstanceTenant

DELETE

/api/management/v2/MfaInstance/{id}/tenants

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"mfaTypeId": "string",

  

"subscriptionId": "string",

  

"hasConfigurationError": true,

  

"clientApps": "[Circular Reference]",

  

"tenants": [

  

  

{...}

  

],

  

"idpInstances": [

  

],

  

"proAuthUsers": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

SetMfaInstanceIdpInstances

PUT

/api/management/v2/MfaInstance/{id}/idpinstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"mfaTypeId": "string",

  

"subscriptionId": "string",

  

"hasConfigurationError": true,

  

"clientApps": "[Circular Reference]",

  

"tenants": [

  

  

{...}

  

],

  

"idpInstances": [

  

],

  

"proAuthUsers": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

AddMfaInstanceIdpInstance

POST

/api/management/v2/MfaInstance/{id}/idpinstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"mfaTypeId": "string",

  

"subscriptionId": "string",

  

"hasConfigurationError": true,

  

"clientApps": "[Circular Reference]",

  

"tenants": [

  

  

{...}

  

],

  

"idpInstances": [

  

],

  

"proAuthUsers": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

RemoveMfaInstanceIdpInstance

DELETE

/api/management/v2/MfaInstance/{id}/idpinstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"mfaTypeId": "string",

  

"subscriptionId": "string",

  

"hasConfigurationError": true,

  

"clientApps": "[Circular Reference]",

  

"tenants": [

  

  

{...}

  

],

  

"idpInstances": [

  

],

  

"proAuthUsers": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

SetMfaInstanceClientApps

PUT

/api/management/v2/MfaInstance/{id}/clientapps

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"mfaTypeId": "string",

  

"subscriptionId": "string",

  

"hasConfigurationError": true,

  

"clientApps": "[Circular Reference]",

  

"tenants": [

  

  

{...}

  

],

  

"idpInstances": [

  

],

  

"proAuthUsers": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

AddMfaInstanceClientApp

POST

/api/management/v2/MfaInstance/{id}/clientapps

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"mfaTypeId": "string",

  

"subscriptionId": "string",

  

"hasConfigurationError": true,

  

"clientApps": "[Circular Reference]",

  

"tenants": [

  

  

{...}

  

],

  

"idpInstances": [

  

],

  

"proAuthUsers": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

RemoveMfaInstanceClientApp

DELETE

/api/management/v2/MfaInstance/{id}/clientapps

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"mfaTypeId": "string",

  

"subscriptionId": "string",

  

"hasConfigurationError": true,

  

"clientApps": "[Circular Reference]",

  

"tenants": [

  

  

{...}

  

],

  

"idpInstances": [

  

],

  

"proAuthUsers": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

SetIdpTypes

PUT

/api/management/v2/MfaInstance/{id}/idptypes

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"mfaTypeId": "string",

  

"subscriptionId": "string",

  

"hasConfigurationError": true,

  

"clientApps": "[Circular Reference]",

  

"tenants": [

  

  

{...}

  

],

  

"idpInstances": [

  

],

  

"proAuthUsers": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

AddIdpType

POST

/api/management/v2/MfaInstance/{id}/idptypes

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"mfaTypeId": "string",

  

"subscriptionId": "string",

  

"hasConfigurationError": true,

  

"clientApps": "[Circular Reference]",

  

"tenants": [

  

  

{...}

  

],

  

"idpInstances": [

  

],

  

"proAuthUsers": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

RemoveIdpType

DELETE

/api/management/v2/MfaInstance/{id}/idptypes

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"mfaTypeId": "string",

  

"subscriptionId": "string",

  

"hasConfigurationError": true,

  

"clientApps": "[Circular Reference]",

  

"tenants": [

  

  

{...}

  

],

  

"idpInstances": [

  

],

  

"proAuthUsers": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

SetMfaInstanceProAuthUsers

PUT

/api/management/v2/MfaInstance/{id}/proauthusers

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"mfaTypeId": "string",

  

"subscriptionId": "string",

  

"hasConfigurationError": true,

  

"clientApps": "[Circular Reference]",

  

"tenants": [

  

  

{...}

  

],

  

"idpInstances": [

  

],

  

"proAuthUsers": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

AddMfaInstanceProAuthUser

POST

/api/management/v2/MfaInstance/{id}/proauthusers

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"mfaTypeId": "string",

  

"subscriptionId": "string",

  

"hasConfigurationError": true,

  

"clientApps": "[Circular Reference]",

  

"tenants": [

  

  

{...}

  

],

  

"idpInstances": [

  

],

  

"proAuthUsers": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

RemoveMfaInstanceProAuthUser

DELETE

/api/management/v2/MfaInstance/{id}/proauthusers

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"executionOrder": 0,

  

"isActive": true,

  

"mfaTypeId": "string",

  

"subscriptionId": "string",

  

"hasConfigurationError": true,

  

"clientApps": "[Circular Reference]",

  

"tenants": [

  

  

{...}

  

],

  

"idpInstances": [

  

],

  

"proAuthUsers": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

MfaInstanceMetadata

Operations

GET/api/management/v2/MfaInstanceMetadata/{mfaInstanceId}/{key}PUT/api/management/v2/MfaInstanceMetadata/{mfaInstanceId}/{key}DELETE/api/management/v2/MfaInstanceMetadata/{mfaInstanceId}/{key}PATCH/api/management/v2/MfaInstanceMetadata/{mfaInstanceId}/{key}GET/api/management/v2/MfaInstanceMetadata/{mfaInstanceId}POST/api/management/v2/MfaInstanceMetadata/{mfaInstanceId}

---

GetMfaInstanceMetadata

GET

/api/management/v2/MfaInstanceMetadata/{mfaInstanceId}/{key}

Responses

OK

Content-Type

application/json

{

  

"mfaInstanceId": "string",

  

"key": "string",

  

"value": "string",

  

"concurrencyToken": "string"

}

---

UpdateMfaInstanceMetadata

PUT

/api/management/v2/MfaInstanceMetadata/{mfaInstanceId}/{key}

Request Body

{

  

"value": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"mfaInstanceId": "string",

  

"key": "string",

  

"value": "string",

  

"concurrencyToken": "string"

}

---

DeleteMfaInstanceMetadata

DELETE

/api/management/v2/MfaInstanceMetadata/{mfaInstanceId}/{key}

Responses

Bad Request

Content-Type

application/json

{

  

"type": "string",

  

"title": "string",

  

"status": null,

  

"detail": "string",

  

"instance": "string"

}

---

PatchMfaInstanceMetadata

PATCH

/api/management/v2/MfaInstanceMetadata/{mfaInstanceId}/{key}

Request Body

{

  

"value": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"mfaInstanceId": "string",

  

"key": "string",

  

"value": "string",

  

"concurrencyToken": "string"

}

---

GetMfaInstanceMetadataByMfaInstanceId

GET

/api/management/v2/MfaInstanceMetadata/{mfaInstanceId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"mfaInstanceId": "string",

  

  

"key": "string",

  

  

"value": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateMfaInstanceMetadata

POST

/api/management/v2/MfaInstanceMetadata/{mfaInstanceId}

Request Body

{

  

"mfaInstanceId": "string",

  

"key": "string",

  

"value": "string"

}

Responses

Created

Content-Type

application/json

{

  

"mfaInstanceId": "string",

  

"key": "string",

  

"value": "string",

  

"concurrencyToken": "string"

}

---

MfaType

Operations

GET/api/management/v2/MfaType/{id}PUT/api/management/v2/MfaType/{id}PATCH/api/management/v2/MfaType/{id}PUT/api/management/v2/MfaType/batchGET/api/management/v2/MfaType/name/{name}GET/api/management/v2/MfaType

---

GetMfaType

GET

/api/management/v2/MfaType/{id}

Responses

OK

Content-Type

application/json

{

  

"id": null,

  

"name": "string",

  

"factoryType": "string",

  

"isEnabled": true,

  

"concurrencyToken": "string"

}

---

UpdateMfaType

PUT

/api/management/v2/MfaType/{id}

Request Body

{

  

"id": "string",

  

"name": "string",

  

"factoryType": "string",

  

"isEnabled": true,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": null,

  

"name": "string",

  

"factoryType": "string",

  

"isEnabled": true,

  

"concurrencyToken": "string"

}

---

PatchMfaType

PATCH

/api/management/v2/MfaType/{id}

Request Body

{

  

"name": "string",

  

"factoryType": "string",

  

"isEnabled": true,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": null,

  

"name": "string",

  

"factoryType": "string",

  

"isEnabled": true,

  

"concurrencyToken": "string"

}

---

UpdateMfaTypeBatch

PUT

/api/management/v2/MfaType/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"factoryType": "string",

  

  

"isEnabled": true,

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": null,

  

  

"name": "string",

  

  

"factoryType": "string",

  

  

"isEnabled": true,

  

  

"concurrencyToken": "string"

  

}

]

---

GetMfaTypeByName

GET

/api/management/v2/MfaType/name/{name}

Responses

OK

Content-Type

application/json

{

  

"id": null,

  

"name": "string",

  

"factoryType": "string",

  

"isEnabled": true,

  

"concurrencyToken": "string"

}

---

GetMfaTypes

GET

/api/management/v2/MfaType

Responses

OK

Content-Type

application/json

[

]

---

Option

Operations

GET/api/management/v2/OptionPOST/api/management/v2/OptionPUT/api/management/v2/Option/batchPOST/api/management/v2/Option/batchDELETE/api/management/v2/Option/batchGET/api/management/v2/Option/{id}PUT/api/management/v2/Option/{id}DELETE/api/management/v2/Option/{id}PATCH/api/management/v2/Option/{id}GET/api/management/v2/Option/type/{type}/ref/{refId}/name/{name}/valueGET/api/management/v2/Option/type/{type}/ref/{refId}/name/{name}GET/api/management/v2/Option/type/{type}/ref/{refId}

---

GetOptions

GET

/api/management/v2/Option

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"value": "string",

  

  

"hasConfigurationError": true,

  

  

"applyToIdpInstanceId": "string",

  

  

"applyToMfaInstanceId": "string",

  

  

"applyToTenantId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateOption

POST

/api/management/v2/Option

Request Body

{

  

"id": "string",

  

"name": "string",

  

"value": "string",

  

"applyToIdpInstanceId": "string",

  

"applyToMfaInstanceId": "string",

  

"applyToTenantId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"value": "string",

  

"hasConfigurationError": true,

  

"applyToIdpInstanceId": "string",

  

"applyToMfaInstanceId": "string",

  

"applyToTenantId": "string",

  

"concurrencyToken": "string"

}

---

UpdateBatch

PUT

/api/management/v2/Option/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"value": "string",

  

  

"applyToIdpInstanceId": "string",

  

  

"applyToMfaInstanceId": "string",

  

  

"applyToTenantId": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateBatch

POST

/api/management/v2/Option/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"value": "string",

  

  

"applyToIdpInstanceId": "string",

  

  

"applyToMfaInstanceId": "string",

  

  

"applyToTenantId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteBatch

DELETE

/api/management/v2/Option/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetOption

GET

/api/management/v2/Option/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"value": "string",

  

"hasConfigurationError": true,

  

"applyToIdpInstanceId": "string",

  

"applyToMfaInstanceId": "string",

  

"applyToTenantId": "string",

  

"concurrencyToken": "string"

}

---

UpdateOption

PUT

/api/management/v2/Option/{id}

Request Body

{

  

"id": "string",

  

"name": "string",

  

"value": "string",

  

"applyToIdpInstanceId": "string",

  

"applyToMfaInstanceId": "string",

  

"applyToTenantId": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"value": "string",

  

"hasConfigurationError": true,

  

"applyToIdpInstanceId": "string",

  

"applyToMfaInstanceId": "string",

  

"applyToTenantId": "string",

  

"concurrencyToken": "string"

}

---

DeleteOption

DELETE

/api/management/v2/Option/{id}

Responses

No Content

---

PatchOption

PATCH

/api/management/v2/Option/{id}

Request Body

{

  

"name": null,

  

"value": null,

  

"applyToIdpInstanceId": null,

  

"applyToMfaInstanceId": null,

  

"applyToTenantId": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"value": "string",

  

"hasConfigurationError": true,

  

"applyToIdpInstanceId": "string",

  

"applyToMfaInstanceId": "string",

  

"applyToTenantId": "string",

  

"concurrencyToken": "string"

}

---

GetOptionValueByName

GET

/api/management/v2/Option/type/{type}/ref/{refId}/name/{name}/value

Responses

OK

Content-Type

application/json

"string"

---

GetOptionByType

GET

/api/management/v2/Option/type/{type}/ref/{refId}/name/{name}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"value": "string",

  

"hasConfigurationError": true,

  

"applyToIdpInstanceId": "string",

  

"applyToMfaInstanceId": "string",

  

"applyToTenantId": "string",

  

"concurrencyToken": "string"

}

---

GetOptionsByType

GET

/api/management/v2/Option/type/{type}/ref/{refId}

Responses

OK

Content-Type

application/json

[

]

---

OptionMetadata

Operations

GET/api/management/v2/OptionMetadataGET/api/management/v2/OptionMetadata/{id}GET/api/management/v2/OptionMetadata/type/{type}/ref/{refId}/name/{name}GET/api/management/v2/OptionMetadata/type/{type}/ref/{refId}

---

GetOptionMetadatas

GET

/api/management/v2/OptionMetadata

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"titleLabelId": "string",

  

  

"helpLabelId": "string",

  

  

"labelScope": "string",

  

  

"displayGroupLabelId": "string",

  

  

"displayOrder": 0,

  

  

"allowedValues": null,

  

  

"category": "string",

  

  

"isMandatory": true,

  

  

"defaultValue": "string",

  

  

"optionType": "string",

  

  

"dataType": "string",

  

  

"editorType": "string",

  

  

"optionTargetType": "string",

  

  

"applyToIdpTypeId": "string",

  

  

"applyToMfaTypeId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

GetOptionMetadata

GET

/api/management/v2/OptionMetadata/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"titleLabelId": "string",

  

"helpLabelId": "string",

  

"labelScope": "string",

  

"displayGroupLabelId": "string",

  

"displayOrder": 0,

  

"allowedValues": null,

  

"category": "string",

  

"isMandatory": true,

  

"defaultValue": "string",

  

"optionType": "string",

  

"dataType": "string",

  

"editorType": "string",

  

"optionTargetType": "string",

  

"applyToIdpTypeId": "string",

  

"applyToMfaTypeId": "string",

  

"concurrencyToken": "string"

}

---

GetOptionMetadataByName

GET

/api/management/v2/OptionMetadata/type/{type}/ref/{refId}/name/{name}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"titleLabelId": "string",

  

"helpLabelId": "string",

  

"labelScope": "string",

  

"displayGroupLabelId": "string",

  

"displayOrder": 0,

  

"allowedValues": null,

  

"category": "string",

  

"isMandatory": true,

  

"defaultValue": "string",

  

"optionType": "string",

  

"dataType": "string",

  

"editorType": "string",

  

"optionTargetType": "string",

  

"applyToIdpTypeId": "string",

  

"applyToMfaTypeId": "string",

  

"concurrencyToken": "string"

}

---

GetOptionsMetadatas

GET

/api/management/v2/OptionMetadata/type/{type}/ref/{refId}

Responses

OK

Content-Type

application/json

[

]

---

PasskeyApproval

Operations

GET/api/management/v2/idpinstances/{idpInstanceId}/passkey-approvalsGET/api/management/v2/idpinstances/{idpInstanceId}/passkey-approvals/queueGET/api/management/v2/idpinstances/{idpInstanceId}/passkey-approvals/{approvalRequestId}POST/api/management/v2/idpinstances/{idpInstanceId}/passkey-approvals/{approvalRequestId}/approvePOST/api/management/v2/idpinstances/{idpInstanceId}/passkey-approvals/{approvalRequestId}/rejectPOST/api/management/v2/idpinstances/{idpInstanceId}/passkey-approvals/{approvalRequestId}/cancel

---

GetPasskeyApprovals

GET

/api/management/v2/idpinstances/{idpInstanceId}/passkey-approvals

Responses

OK

Content-Type

[

  

{

  

  

"id": "string",

  

  

"operation": "string",

  

  

"commandHash": "string",

  

  

"concurrencyFingerprint": "string",

  

  

"requestedBy": "string",

  

  

"requestedOn": "string",

  

  

"requiredApprovals": 0,

  

  

"approvedBy": [...],

  

  

"currentApprovals": 0,

  

  

"status": "string",

  

  

"expiresOn": "string",

  

  

"recommendationProposal": null,

  

  

"optionsProposal": null,

  

  

"rpRetirementProposal": null

  

}

]

---

ListPasskeyApprovals

GET

/api/management/v2/idpinstances/{idpInstanceId}/passkey-approvals/queue

Responses

OK

Content-Type

{

  

"items": [

  

],

  

"totalCount": 0

}

---

GetPasskeyApproval

GET

/api/management/v2/idpinstances/{idpInstanceId}/passkey-approvals/{approvalRequestId}

Responses

OK

Content-Type

{

  

"id": "string",

  

"operation": "string",

  

"commandHash": "string",

  

"concurrencyFingerprint": "string",

  

"requestedBy": "string",

  

"requestedOn": "string",

  

"requiredApprovals": 0,

  

"approvedBy": [

  

  

"string"

  

],

  

"currentApprovals": 0,

  

"status": "string",

  

"expiresOn": "string",

  

"recommendationProposal": null,

  

"optionsProposal": null,

  

"rpRetirementProposal": null

}

---

ApprovePasskeyApproval

POST

/api/management/v2/idpinstances/{idpInstanceId}/passkey-approvals/{approvalRequestId}/approve

Responses

OK

Content-Type

{

  

"id": "string",

  

"operation": "string",

  

"commandHash": "string",

  

"concurrencyFingerprint": "string",

  

"requestedBy": "string",

  

"requestedOn": "string",

  

"requiredApprovals": 0,

  

"approvedBy": [

  

  

"string"

  

],

  

"currentApprovals": 0,

  

"status": "string",

  

"expiresOn": "string",

  

"recommendationProposal": null,

  

"optionsProposal": null,

  

"rpRetirementProposal": null

}

---

RejectPasskeyApproval

POST

/api/management/v2/idpinstances/{idpInstanceId}/passkey-approvals/{approvalRequestId}/reject

Responses

OK

Content-Type

{

  

"id": "string",

  

"operation": "string",

  

"commandHash": "string",

  

"concurrencyFingerprint": "string",

  

"requestedBy": "string",

  

"requestedOn": "string",

  

"requiredApprovals": 0,

  

"approvedBy": [

  

  

"string"

  

],

  

"currentApprovals": 0,

  

"status": "string",

  

"expiresOn": "string",

  

"recommendationProposal": null,

  

"optionsProposal": null,

  

"rpRetirementProposal": null

}

---

CancelPasskeyApproval

POST

/api/management/v2/idpinstances/{idpInstanceId}/passkey-approvals/{approvalRequestId}/cancel

Responses

OK

Content-Type

{

  

"id": "string",

  

"operation": "string",

  

"commandHash": "string",

  

"concurrencyFingerprint": "string",

  

"requestedBy": "string",

  

"requestedOn": "string",

  

"requiredApprovals": 0,

  

"approvedBy": [

  

  

"string"

  

],

  

"currentApprovals": 0,

  

"status": "string",

  

"expiresOn": "string",

  

"recommendationProposal": null,

  

"optionsProposal": null,

  

"rpRetirementProposal": null

}

---

PasskeyMigration

Operations

GET/api/management/v2/idpinstances/{idpInstanceId}/passkey-migration/legacy-backfillPOST/api/management/v2/idpinstances/{idpInstanceId}/passkey-migration/legacy-backfill/batches

---

GetPasskeyLegacyMigrationStatus

GET

/api/management/v2/idpinstances/{idpInstanceId}/passkey-migration/legacy-backfill

Responses

OK

Content-Type

{

  

"hasUsersRemaining": true,

  

"hasCredentialsRemaining": true,

  

"isComplete": true,

  

"effectiveRpId": "string",

  

"policyFingerprint": "string"

}

---

RunPasskeyLegacyMigrationBatch

POST

/api/management/v2/idpinstances/{idpInstanceId}/passkey-migration/legacy-backfill/batches

Request Body

{

  

"batchSize": 0,

  

"allNodesRunCurrentVersion": true

}

Responses

OK

Content-Type

{

  

"usersProcessed": 0,

  

"verifiedSecurityContactsCreated": 0,

  

"credentialsProcessed": 0,

  

"credentialRpIdsDerived": 0,

  

"credentialAlgorithmsDerived": 0,

  

"credentialDerivationErrors": 0,

  

"status": {

  

  

"hasUsersRemaining": true,

  

  

"hasCredentialsRemaining": true,

  

  

"isComplete": true,

  

  

"effectiveRpId": "string",

  

  

"policyFingerprint": "string"

  

}

}

---

PasskeyPolicy

Operations

GET/api/management/v2/idpinstances/{idpInstanceId}/passkey-policyPOST/api/management/v2/idpinstances/{idpInstanceId}/passkey-policy/previewPOST/api/management/v2/idpinstances/{idpInstanceId}/passkey-policy/applyPOST/api/management/v2/idpinstances/{idpInstanceId}/passkey-policy/approvals

---

GetEffectivePasskeyPolicy

GET

/api/management/v2/idpinstances/{idpInstanceId}/passkey-policy

Responses

OK

Content-Type

{

  

"idpInstanceId": "string",

  

"enabled": true,

  

"loginExperience": "string",

  

"enrollmentPolicy": "string",

  

"enrollmentGracePeriodSeconds": 0,

  

"maxCredentialsPerUser": 0,

  

"requiredCredentialCount": 0,

  

"credentialDiversityPolicy": "string",

  

"existingCredentialEnforcement": "string",

  

"passwordPolicy": "string",

  

"passwordRemovalGracePeriodSeconds": 0,

  

"passwordRecreationPolicy": "string",

  

"credentialMaturationSeconds": 0,

  

"administrativeLastCredentialRemovalPolicy": "string",

  

"userVerificationPolicy": "string",

  

"authenticatorClassPolicy": "string",

  

"attestationConveyance": "string",

  

"attestationTrustPolicy": "string",

  

"allowedAaguids": [

  

  

"string"

  

],

  

"blockedAaguids": [

  

],

  

"undesiredAuthenticatorStatusPolicy": "string",

  

"allowedAlgorithms": [

  

  

undefined

  

],

  

"signatureCounterAnomalyPolicy": "string",

  

"riskProviderMode": "string",

  

"rpId": "string",

  

"rpName": "string",

  

"allowedOrigins": [

  

],

  

"authenticatorTimeoutSeconds": 0,

  

"timestampDriftToleranceMilliseconds": 0,

  

"bindingAuthenticationPolicy": "string",

  

"bindingAuthenticationMaxAgeSeconds": 0,

  

"deletionAuthenticationPolicy": "string",

  

"suspiciousBindingHoldSeconds": 0,

  

"securityNotificationMode": "string",

  

"requiredVerifiedSecurityContactCount": 0,

  

"revokedCredentialRetentionSeconds": 0,

  

"highImpactApprovals": {

  

  

"additionalProperties": 0

  

},

  

"recoveryRoutes": {

  

  

"version": 0,

  

  

"routes": [...]

  

},

  

"initialEnrollmentRoutes": {

  

  

"version": 0,

  

  

"routes": [...]

  

},

  

"recoveryCodeCount": 0,

  

"recoveryEmailTokenLifetimeSeconds": 0,

  

"temporaryAccessPassLifetimeSeconds": 0,

  

"recoverySessionLifetimeSeconds": 0,

  

"legacyEnforcePasswordless": true,

  

"legacyAllowUnrestrictedNonUv": true,

  

"fingerprint": "string"

}

---

PreviewPasskeyPolicyChange

POST

/api/management/v2/idpinstances/{idpInstanceId}/passkey-policy/preview

Request Body

{

  

"options": {

  

  

"additionalProperties": "string"

  

},

  

"removeOptionIds": null

}

Responses

OK

Content-Type

{

  

"idpInstanceId": "string",

  

"changes": [

  

  

{...}

  

],

  

"validationErrors": [

  

],

  

"warnings": [

  

],

  

"isValid": true,

  

"hasDestructiveImpact": true,

  

"approvalOperation": "string",

  

"requiredApprovals": 0,

  

"previewFingerprint": "string"

}

---

ApplyPasskeyPolicyChange

POST

/api/management/v2/idpinstances/{idpInstanceId}/passkey-policy/apply

Request Body

{

  

"options": {

  

  

"additionalProperties": "string"

  

},

  

"previewFingerprint": "string",

  

"approvalRequestId": "string",

  

"removeOptionIds": null

}

Responses

OK

Content-Type

{

  

"idpInstanceId": "string",

  

"previewFingerprint": "string",

  

"optionIds": [

  

],

  

"removedOptionIds": [

  

]

}

---

RequestPasskeyPolicyChangeApproval

POST

/api/management/v2/idpinstances/{idpInstanceId}/passkey-policy/approvals

Request Body

{

  

"options": {

  

  

"additionalProperties": "string"

  

},

  

"previewFingerprint": "string",

  

"removeOptionIds": null

}

Responses

OK

Content-Type

{

  

"id": "string",

  

"operation": "string",

  

"commandHash": "string",

  

"concurrencyFingerprint": "string",

  

"requestedBy": "string",

  

"requestedOn": "string",

  

"requiredApprovals": 0,

  

"approvedBy": [

  

  

"string"

  

],

  

"currentApprovals": 0,

  

"status": "string",

  

"expiresOn": "string",

  

"recommendationProposal": null,

  

"optionsProposal": null,

  

"rpRetirementProposal": null

}

---

PasskeyPolicyRecommendation

Operations

GET/api/management/v2/idpinstances/{idpInstanceId}/passkey-policy/recommendationsGET/api/management/v2/idpinstances/{idpInstanceId}/passkey-policy/recommendations/{recommendationId}/versions/{recommendationVersion}POST/api/management/v2/idpinstances/{idpInstanceId}/passkey-policy/recommendations/{recommendationId}/versions/{recommendationVersion}/previewPOST/api/management/v2/idpinstances/{idpInstanceId}/passkey-policy/recommendations/applyPOST/api/management/v2/idpinstances/{idpInstanceId}/passkey-policy/recommendations/approvalsPOST/api/management/v2/idpinstances/{idpInstanceId}/passkey-policy/recommendations/approvals/{approvalRequestId}/approve

---

GetPasskeyPolicyRecommendations

GET

/api/management/v2/idpinstances/{idpInstanceId}/passkey-policy/recommendations

Responses

OK

Content-Type

[

  

{

  

  

"id": "string",

  

  

"version": 0,

  

  

"displayName": "string",

  

  

"description": "string",

  

  

"fingerprint": "string",

  

  

"options": {...}

  

}

]

---

GetPasskeyPolicyRecommendation

GET

/api/management/v2/idpinstances/{idpInstanceId}/passkey-policy/recommendations/{recommendationId}/versions/{recommendationVersion}

Responses

OK

Content-Type

{

  

"id": "string",

  

"version": 0,

  

"displayName": "string",

  

"description": "string",

  

"fingerprint": "string",

  

"options": {

  

  

"additionalProperties": "string"

  

}

}

---

Preview

POST

/api/management/v2/idpinstances/{idpInstanceId}/passkey-policy/recommendations/{recommendationId}/versions/{recommendationVersion}/preview

Responses

OK

Content-Type

{

  

"idpInstanceId": "string",

  

"recommendation": {

  

  

"id": "string",

  

  

"version": 0,

  

  

"displayName": "string",

  

  

"description": "string",

  

  

"fingerprint": "string",

  

  

"options": {...}

  

},

  

"changes": [

  

],

  

"validationErrors": [

  

],

  

"warnings": [

  

],

  

"isValid": true,

  

"hasDestructiveImpact": true,

  

"requiredApprovals": 0,

  

"previewFingerprint": "string"

}

---

Apply

POST

/api/management/v2/idpinstances/{idpInstanceId}/passkey-policy/recommendations/apply

Request Body

{

  

"recommendationId": "string",

  

"version": 0,

  

"recommendationFingerprint": "string",

  

"previewFingerprint": "string",

  

"approvalRequestId": "string"

}

Responses

OK

Content-Type

{

  

"idpInstanceId": "string",

  

"recommendationId": "string",

  

"version": 0,

  

"recommendationFingerprint": "string",

  

"appliedPreviewFingerprint": "string",

  

"optionIds": [

  

]

}

---

RequestApproval

POST

/api/management/v2/idpinstances/{idpInstanceId}/passkey-policy/recommendations/approvals

Request Body

{

  

"command": {

  

  

"recommendationId": "string",

  

  

"version": 0,

  

  

"recommendationFingerprint": "string",

  

  

"previewFingerprint": "string",

  

  

"approvalRequestId": "string"

  

}

}

Responses

Created

Content-Type

{

  

"id": "string",

  

"operation": "string",

  

"commandHash": "string",

  

"concurrencyFingerprint": "string",

  

"requestedBy": "string",

  

"requestedOn": "string",

  

"requiredApprovals": 0,

  

"approvedBy": [

  

  

"string"

  

],

  

"currentApprovals": 0,

  

"status": "string",

  

"expiresOn": "string",

  

"recommendationProposal": null,

  

"optionsProposal": null,

  

"rpRetirementProposal": null

}

---

ApprovePasskeyPolicyRecommendation

POST

/api/management/v2/idpinstances/{idpInstanceId}/passkey-policy/recommendations/approvals/{approvalRequestId}/approve

Responses

OK

Content-Type

{

  

"id": "string",

  

"operation": "string",

  

"commandHash": "string",

  

"concurrencyFingerprint": "string",

  

"requestedBy": "string",

  

"requestedOn": "string",

  

"requiredApprovals": 0,

  

"approvedBy": [

  

  

"string"

  

],

  

"currentApprovals": 0,

  

"status": "string",

  

"expiresOn": "string",

  

"recommendationProposal": null,

  

"optionsProposal": null,

  

"rpRetirementProposal": null

}

---

PasskeyRpIdMigration

Operations

GET/api/management/v2/idpinstances/{idpInstanceId}/passkey-rp-migration/activePOST/api/management/v2/idpinstances/{idpInstanceId}/passkey-rp-migrationPOST/api/management/v2/idpinstances/{idpInstanceId}/passkey-rp-migration/{migrationId}/domain-challenges/rotatePOST/api/management/v2/idpinstances/{idpInstanceId}/passkey-rp-migration/{migrationId}/domain-verificationPOST/api/management/v2/idpinstances/{idpInstanceId}/passkey-rp-migration/{migrationId}/retirement-approvalPOST/api/management/v2/idpinstances/{idpInstanceId}/passkey-rp-migration/approvals/{approvalRequestId}/approvePOST/api/management/v2/idpinstances/{idpInstanceId}/passkey-rp-migration/{migrationId}/retire

---

GetActive

GET

/api/management/v2/idpinstances/{idpInstanceId}/passkey-rp-migration/active

Responses

OK

Content-Type

{

  

"hasActiveMigration": true,

  

"migration": null

}

---

Start

POST

/api/management/v2/idpinstances/{idpInstanceId}/passkey-rp-migration

Request Body

{

  

"legacyRpId": "string",

  

"newPrimaryRpId": "string",

  

"legacyOrigin": "string",

  

"newPrimaryOrigin": "string",

  

"overlapSeconds": 0

}

Responses

Created

Content-Type

{

  

"progress": {

  

  

"id": "string",

  

  

"legacyRpId": "string",

  

  

"newPrimaryRpId": "string",

  

  

"legacyOrigin": "string",

  

  

"newPrimaryOrigin": "string",

  

  

"status": "string",

  

  

"startedOn": "string",

  

  

"overlapExpiresOn": "string",

  

  

"activeLegacyCredentials": 0,

  

  

"activeNewCredentials": 0,

  

  

"usersStillRequiringNewCredential": 0,

  

  

"concurrencyFingerprint": "string",

  

  

"domainsVerified": true,

  

  

"legacyDnsRecordName": "string",

  

  

"newDnsRecordName": "string",

  

  

"domainChallengeExpiresOn": "string",

  

  

"domainVerificationLastCheckedOn": "string"

  

},

  

"legacyDomainChallenge": {

  

  

"recordName": "string",

  

  

"recordType": "string",

  

  

"recordValue": "string"

  

},

  

"newDomainChallenge": {

  

  

"recordName": "string",

  

  

"recordType": "string",

  

  

"recordValue": "string"

  

}

}

---

RotateDomainChallenges

POST

/api/management/v2/idpinstances/{idpInstanceId}/passkey-rp-migration/{migrationId}/domain-challenges/rotate

Responses

OK

Content-Type

{

  

"progress": {

  

  

"id": "string",

  

  

"legacyRpId": "string",

  

  

"newPrimaryRpId": "string",

  

  

"legacyOrigin": "string",

  

  

"newPrimaryOrigin": "string",

  

  

"status": "string",

  

  

"startedOn": "string",

  

  

"overlapExpiresOn": "string",

  

  

"activeLegacyCredentials": 0,

  

  

"activeNewCredentials": 0,

  

  

"usersStillRequiringNewCredential": 0,

  

  

"concurrencyFingerprint": "string",

  

  

"domainsVerified": true,

  

  

"legacyDnsRecordName": "string",

  

  

"newDnsRecordName": "string",

  

  

"domainChallengeExpiresOn": "string",

  

  

"domainVerificationLastCheckedOn": "string"

  

},

  

"legacyDomainChallenge": {

  

  

"recordName": "string",

  

  

"recordType": "string",

  

  

"recordValue": "string"

  

},

  

"newDomainChallenge": {

  

  

"recordName": "string",

  

  

"recordType": "string",

  

  

"recordValue": "string"

  

}

}

---

VerifyDomainControl

POST

/api/management/v2/idpinstances/{idpInstanceId}/passkey-rp-migration/{migrationId}/domain-verification

Responses

OK

Content-Type

{

  

"id": "string",

  

"legacyRpId": "string",

  

"newPrimaryRpId": "string",

  

"legacyOrigin": "string",

  

"newPrimaryOrigin": "string",

  

"status": "string",

  

"startedOn": "string",

  

"overlapExpiresOn": "string",

  

"activeLegacyCredentials": 0,

  

"activeNewCredentials": 0,

  

"usersStillRequiringNewCredential": 0,

  

"concurrencyFingerprint": "string",

  

"domainsVerified": true,

  

"legacyDnsRecordName": "string",

  

"newDnsRecordName": "string",

  

"domainChallengeExpiresOn": "string",

  

"domainVerificationLastCheckedOn": "string"

}

---

RequestRetirementApproval

POST

/api/management/v2/idpinstances/{idpInstanceId}/passkey-rp-migration/{migrationId}/retirement-approval

Responses

OK

Content-Type

{

  

"id": "string",

  

"operation": "string",

  

"commandHash": "string",

  

"concurrencyFingerprint": "string",

  

"requestedBy": "string",

  

"requestedOn": "string",

  

"requiredApprovals": 0,

  

"approvedBy": [

  

  

"string"

  

],

  

"currentApprovals": 0,

  

"status": "string",

  

"expiresOn": "string",

  

"recommendationProposal": null,

  

"optionsProposal": null,

  

"rpRetirementProposal": null

}

---

ApprovePasskeyRpIdMigration

POST

/api/management/v2/idpinstances/{idpInstanceId}/passkey-rp-migration/approvals/{approvalRequestId}/approve

Responses

OK

Content-Type

{

  

"id": "string",

  

"operation": "string",

  

"commandHash": "string",

  

"concurrencyFingerprint": "string",

  

"requestedBy": "string",

  

"requestedOn": "string",

  

"requiredApprovals": 0,

  

"approvedBy": [

  

  

"string"

  

],

  

"currentApprovals": 0,

  

"status": "string",

  

"expiresOn": "string",

  

"recommendationProposal": null,

  

"optionsProposal": null,

  

"rpRetirementProposal": null

}

---

Retire

POST

/api/management/v2/idpinstances/{idpInstanceId}/passkey-rp-migration/{migrationId}/retire

Request Body

{

  

"approvalRequestId": "string",

  

"forceRecovery": true

}

Responses

No Content

---

PasswordPolicy

Operations

GET/api/management/v2/idpinstances/{idpInstanceId}/password-policy/recommendationsPOST/api/management/v2/idpinstances/{idpInstanceId}/password-policy/recommendations/{recommendationId}/versions/{recommendationVersion}/previewPOST/api/management/v2/idpinstances/{idpInstanceId}/password-policy/recommendations/applyGET/api/management/v2/idpinstances/{idpInstanceId}/password-policyPOST/api/management/v2/idpinstances/{idpInstanceId}/password-policy/preview

---

GetRecommendations

GET

/api/management/v2/idpinstances/{idpInstanceId}/password-policy/recommendations

Responses

OK

Content-Type

[

  

{

  

  

"id": "string",

  

  

"version": 0,

  

  

"displayName": "string",

  

  

"description": "string",

  

  

"fingerprint": "string",

  

  

"options": {...}

  

}

]

---

PreviewRecommendation

POST

/api/management/v2/idpinstances/{idpInstanceId}/password-policy/recommendations/{recommendationId}/versions/{recommendationVersion}/preview

Responses

OK

Content-Type

{

  

"idpInstanceId": "string",

  

"recommendation": {

  

  

"id": "string",

  

  

"version": 0,

  

  

"displayName": "string",

  

  

"description": "string",

  

  

"fingerprint": "string",

  

  

"options": {...}

  

},

  

"changes": [

  

  

{...}

  

],

  

"validationErrors": [

  

],

  

"warnings": [

  

],

  

"isValid": true,

  

"previewFingerprint": "string"

}

---

ApplyRecommendation

POST

/api/management/v2/idpinstances/{idpInstanceId}/password-policy/recommendations/apply

Request Body

{

  

"recommendationId": "string",

  

"version": 0,

  

"recommendationFingerprint": "string",

  

"previewFingerprint": "string",

  

"allServingNodesCurrentAttestation": true

}

Responses

OK

Content-Type

{

  

"idpInstanceId": "string",

  

"recommendationId": "string",

  

"version": 0,

  

"recommendationFingerprint": "string",

  

"previewFingerprint": "string",

  

"activatedOn": "string",

  

"optionIds": [

  

]

}

---

GetPasswordPolicy

GET

/api/management/v2/idpinstances/{idpInstanceId}/password-policy

Responses

OK

Content-Type

{

  

"idpInstanceId": "string",

  

"mode": "string",

  

"legacyRegexTimeoutMilliseconds": 0,

  

"minimumLength": 0,

  

"maximumLength": 0,

  

"maximumUtf8Bytes": 0,

  

"unicodeNormalization": "string",

  

"requiredUppercaseCount": 0,

  

"requiredLowercaseCount": 0,

  

"requiredDigitCount": 0,

  

"requiredSymbolCount": 0,

  

"maximumRepeatedRun": 0,

  

"minimumSequenceLengthToReject": 0,

  

"identityDerivedChecks": "string",

  

"localBlocklistEnabled": true,

  

"blocklistDatasetVersion": "string",

  

"strengthEstimatorMode": "string",

  

"minimumStrengthScore": 0,

  

"hashAlgorithm": "string",

  

"hashIterations": 0,

  

"hashSaltBytes": 0,

  

"hashOutputBytes": 0,

  

"fingerprint": "string"

}

---

Preview

POST

/api/management/v2/idpinstances/{idpInstanceId}/password-policy/preview

Request Body

{

  

"options": {

  

  

"additionalProperties": "string"

  

}

}

Responses

OK

Content-Type

{

  

"isValid": true,

  

"validationErrors": [

  

],

  

"effectivePolicy": null

}

---

ProAuthGroup

Operations

GET/api/management/v2/ProAuthGroupPOST/api/management/v2/ProAuthGroupPUT/api/management/v2/ProAuthGroup/batchPOST/api/management/v2/ProAuthGroup/batchDELETE/api/management/v2/ProAuthGroup/batchGET/api/management/v2/ProAuthGroup/{id}PUT/api/management/v2/ProAuthGroup/{id}DELETE/api/management/v2/ProAuthGroup/{id}PATCH/api/management/v2/ProAuthGroup/{id}PUT/api/management/v2/ProAuthGroup/{groupId}/usersPOST/api/management/v2/ProAuthGroup/{groupId}/usersDELETE/api/management/v2/ProAuthGroup/{groupId}/usersPUT/api/management/v2/ProAuthGroup/{groupId}/parentgroupsPOST/api/management/v2/ProAuthGroup/{groupId}/parentgroupsDELETE/api/management/v2/ProAuthGroup/{groupId}/parentgroupsPUT/api/management/v2/ProAuthGroup/{groupId}/membergroupsPOST/api/management/v2/ProAuthGroup/{groupId}/membergroupsDELETE/api/management/v2/ProAuthGroup/{groupId}/membergroupsGET/api/management/v2/ProAuthGroup/idp/{idpId}/scim/{id}GET/api/management/v2/ProAuthGroup/idp/{idpId}/userstore/{id}

---

GetProAuthGroups

GET

/api/management/v2/ProAuthGroup

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"scimExternalId": "string",

  

  

"idpInstanceId": "string",

  

  

"subscriptionId": "string",

  

  

"applyToTenantId": "string",

  

  

"federatedExternalGroupId": "string",

  

  

"scimSynchronized": true,

  

  

"memberUsers": "[Circular Reference]",

  

  

"parentGroups": "[Circular Reference]",

  

  

"memberGroups": "[Circular Reference]",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateProAuthGroup

POST

/api/management/v2/ProAuthGroup

Request Body

{

  

"id": "string",

  

"name": "string",

  

"scimExternalId": "string",

  

"idpInstanceId": "string",

  

"subscriptionId": "string",

  

"applyToTenantId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"scimExternalId": "string",

  

"idpInstanceId": "string",

  

"subscriptionId": "string",

  

"applyToTenantId": "string",

  

"federatedExternalGroupId": "string",

  

"scimSynchronized": true,

  

"memberUsers": "[Circular Reference]",

  

"parentGroups": "[Circular Reference]",

  

"memberGroups": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

UpdateProAuthGroupBatch

PUT

/api/management/v2/ProAuthGroup/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"scimExternalId": "string",

  

  

"applyToTenantId": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateProAuthGroupBatch

POST

/api/management/v2/ProAuthGroup/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"scimExternalId": "string",

  

  

"idpInstanceId": "string",

  

  

"subscriptionId": "string",

  

  

"applyToTenantId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteProAuthGroupBatch

DELETE

/api/management/v2/ProAuthGroup/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetProAuthGroup

GET

/api/management/v2/ProAuthGroup/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"scimExternalId": "string",

  

"idpInstanceId": "string",

  

"subscriptionId": "string",

  

"applyToTenantId": "string",

  

"federatedExternalGroupId": "string",

  

"scimSynchronized": true,

  

"memberUsers": "[Circular Reference]",

  

"parentGroups": "[Circular Reference]",

  

"memberGroups": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

UpdateProAuthGroup

PUT

/api/management/v2/ProAuthGroup/{id}

Request Body

{

  

"id": "string",

  

"name": "string",

  

"scimExternalId": "string",

  

"applyToTenantId": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"scimExternalId": "string",

  

"idpInstanceId": "string",

  

"subscriptionId": "string",

  

"applyToTenantId": "string",

  

"federatedExternalGroupId": "string",

  

"scimSynchronized": true,

  

"memberUsers": "[Circular Reference]",

  

"parentGroups": "[Circular Reference]",

  

"memberGroups": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

DeleteProAuthGroup

DELETE

/api/management/v2/ProAuthGroup/{id}

Responses

No Content

---

PatchProAuthGroup

PATCH

/api/management/v2/ProAuthGroup/{id}

Request Body

{

  

"name": null,

  

"scimExternalId": null,

  

"applyToTenantId": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"scimExternalId": "string",

  

"idpInstanceId": "string",

  

"subscriptionId": "string",

  

"applyToTenantId": "string",

  

"federatedExternalGroupId": "string",

  

"scimSynchronized": true,

  

"memberUsers": "[Circular Reference]",

  

"parentGroups": "[Circular Reference]",

  

"memberGroups": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

SetProAuthGroupMemberUsers

PUT

/api/management/v2/ProAuthGroup/{groupId}/users

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"scimExternalId": "string",

  

"idpInstanceId": "string",

  

"subscriptionId": "string",

  

"applyToTenantId": "string",

  

"federatedExternalGroupId": "string",

  

"scimSynchronized": true,

  

"memberUsers": "[Circular Reference]",

  

"parentGroups": "[Circular Reference]",

  

"memberGroups": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

AddProAuthGroupMemberUser

POST

/api/management/v2/ProAuthGroup/{groupId}/users

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"scimExternalId": "string",

  

"idpInstanceId": "string",

  

"subscriptionId": "string",

  

"applyToTenantId": "string",

  

"federatedExternalGroupId": "string",

  

"scimSynchronized": true,

  

"memberUsers": "[Circular Reference]",

  

"parentGroups": "[Circular Reference]",

  

"memberGroups": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

RemoveProAuthGroupMemberUser

DELETE

/api/management/v2/ProAuthGroup/{groupId}/users

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"scimExternalId": "string",

  

"idpInstanceId": "string",

  

"subscriptionId": "string",

  

"applyToTenantId": "string",

  

"federatedExternalGroupId": "string",

  

"scimSynchronized": true,

  

"memberUsers": "[Circular Reference]",

  

"parentGroups": "[Circular Reference]",

  

"memberGroups": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

SetProAuthGroupParentGroups

PUT

/api/management/v2/ProAuthGroup/{groupId}/parentgroups

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"scimExternalId": "string",

  

"idpInstanceId": "string",

  

"subscriptionId": "string",

  

"applyToTenantId": "string",

  

"federatedExternalGroupId": "string",

  

"scimSynchronized": true,

  

"memberUsers": "[Circular Reference]",

  

"parentGroups": "[Circular Reference]",

  

"memberGroups": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

AddProAuthGroupParentGroup

POST

/api/management/v2/ProAuthGroup/{groupId}/parentgroups

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"scimExternalId": "string",

  

"idpInstanceId": "string",

  

"subscriptionId": "string",

  

"applyToTenantId": "string",

  

"federatedExternalGroupId": "string",

  

"scimSynchronized": true,

  

"memberUsers": "[Circular Reference]",

  

"parentGroups": "[Circular Reference]",

  

"memberGroups": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

RemoveProAuthGroupParentGroup

DELETE

/api/management/v2/ProAuthGroup/{groupId}/parentgroups

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"scimExternalId": "string",

  

"idpInstanceId": "string",

  

"subscriptionId": "string",

  

"applyToTenantId": "string",

  

"federatedExternalGroupId": "string",

  

"scimSynchronized": true,

  

"memberUsers": "[Circular Reference]",

  

"parentGroups": "[Circular Reference]",

  

"memberGroups": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

SetProAuthGroupMemberGroups

PUT

/api/management/v2/ProAuthGroup/{groupId}/membergroups

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"scimExternalId": "string",

  

"idpInstanceId": "string",

  

"subscriptionId": "string",

  

"applyToTenantId": "string",

  

"federatedExternalGroupId": "string",

  

"scimSynchronized": true,

  

"memberUsers": "[Circular Reference]",

  

"parentGroups": "[Circular Reference]",

  

"memberGroups": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

AddProAuthGroupMemberGroup

POST

/api/management/v2/ProAuthGroup/{groupId}/membergroups

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"scimExternalId": "string",

  

"idpInstanceId": "string",

  

"subscriptionId": "string",

  

"applyToTenantId": "string",

  

"federatedExternalGroupId": "string",

  

"scimSynchronized": true,

  

"memberUsers": "[Circular Reference]",

  

"parentGroups": "[Circular Reference]",

  

"memberGroups": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

RemoveProAuthGroupMemberGroup

DELETE

/api/management/v2/ProAuthGroup/{groupId}/membergroups

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"scimExternalId": "string",

  

"idpInstanceId": "string",

  

"subscriptionId": "string",

  

"applyToTenantId": "string",

  

"federatedExternalGroupId": "string",

  

"scimSynchronized": true,

  

"memberUsers": "[Circular Reference]",

  

"parentGroups": "[Circular Reference]",

  

"memberGroups": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

GetScimSynchronizedProAuthGroupByScimId

GET

/api/management/v2/ProAuthGroup/idp/{idpId}/scim/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"scimExternalId": "string",

  

"idpInstanceId": "string",

  

"subscriptionId": "string",

  

"applyToTenantId": "string",

  

"federatedExternalGroupId": "string",

  

"scimSynchronized": true,

  

"memberUsers": "[Circular Reference]",

  

"parentGroups": "[Circular Reference]",

  

"memberGroups": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

GetSynchronizedProAuthGroupByUserStoreId

GET

/api/management/v2/ProAuthGroup/idp/{idpId}/userstore/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"scimExternalId": "string",

  

"idpInstanceId": "string",

  

"subscriptionId": "string",

  

"applyToTenantId": "string",

  

"federatedExternalGroupId": "string",

  

"scimSynchronized": true,

  

"memberUsers": "[Circular Reference]",

  

"parentGroups": "[Circular Reference]",

  

"memberGroups": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

ProAuthGroupMetadata

Operations

GET/api/management/v2/ProAuthGroupMetadata/{proAuthGroupId}POST/api/management/v2/ProAuthGroupMetadata/{proAuthGroupId}GET/api/management/v2/ProAuthGroupMetadata/{proAuthGroupId}/{key}PUT/api/management/v2/ProAuthGroupMetadata/{proAuthGroupId}/{key}DELETE/api/management/v2/ProAuthGroupMetadata/{proAuthGroupId}/{key}PATCH/api/management/v2/ProAuthGroupMetadata/{proAuthGroupId}/{key}

---

GetProAuthGroupMetadataByProAuthGroupId

GET

/api/management/v2/ProAuthGroupMetadata/{proAuthGroupId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"proAuthGroupId": null,

  

  

"key": "string",

  

  

"value": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateProAuthGroupMetadata

POST

/api/management/v2/ProAuthGroupMetadata/{proAuthGroupId}

Request Body

{

  

"proAuthGroupId": "string",

  

"key": "string",

  

"value": "string"

}

Responses

OK

Content-Type

application/json

{

  

"proAuthGroupId": null,

  

"key": "string",

  

"value": "string",

  

"concurrencyToken": "string"

}

---

GetProAuthGroupMetadata

GET

/api/management/v2/ProAuthGroupMetadata/{proAuthGroupId}/{key}

Responses

OK

Content-Type

application/json

{

  

"proAuthGroupId": null,

  

"key": "string",

  

"value": "string",

  

"concurrencyToken": "string"

}

---

UpdateProAuthGroupMetadata

PUT

/api/management/v2/ProAuthGroupMetadata/{proAuthGroupId}/{key}

Request Body

{

  

"value": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"proAuthGroupId": null,

  

"key": "string",

  

"value": "string",

  

"concurrencyToken": "string"

}

---

DeleteProAuthGroupMetadata

DELETE

/api/management/v2/ProAuthGroupMetadata/{proAuthGroupId}/{key}

Responses

Bad Request

Content-Type

application/json

{

  

"type": "string",

  

"title": "string",

  

"status": null,

  

"detail": "string",

  

"instance": "string"

}

---

PatchProAuthGroupMetadata

PATCH

/api/management/v2/ProAuthGroupMetadata/{proAuthGroupId}/{key}

Request Body

{

  

"value": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"proAuthGroupId": null,

  

"key": "string",

  

"value": "string",

  

"concurrencyToken": "string"

}

---

ProAuthGroupRole

Operations

GET/api/management/v2/ProAuthGroupRolePOST/api/management/v2/ProAuthGroupRolePUT/api/management/v2/ProAuthGroupRole/batchPOST/api/management/v2/ProAuthGroupRole/batchDELETE/api/management/v2/ProAuthGroupRole/batchGET/api/management/v2/ProAuthGroupRole/{id}PUT/api/management/v2/ProAuthGroupRole/{id}DELETE/api/management/v2/ProAuthGroupRole/{id}PATCH/api/management/v2/ProAuthGroupRole/{id}GET/api/management/v2/ProAuthGroupRole/proauthgroup/{proAuthGroupId}

---

GetProAuthGroupRoles

GET

/api/management/v2/ProAuthGroupRole

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"roleType": "string",

  

  

"applyToTenantId": "string",

  

  

"applyToIdpInstanceId": "string",

  

  

"proAuthGroupId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateProAuthGroupRole

POST

/api/management/v2/ProAuthGroupRole

Request Body

{

  

"id": "string",

  

"roleType": "string",

  

"applyToTenantId": "string",

  

"applyToIdpInstanceId": "string",

  

"proAuthGroupId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"roleType": "string",

  

"applyToTenantId": "string",

  

"applyToIdpInstanceId": "string",

  

"proAuthGroupId": "string",

  

"concurrencyToken": "string"

}

---

UpdateProAuthGroupRoleBatch

PUT

/api/management/v2/ProAuthGroupRole/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"roleType": "string",

  

  

"applyToTenantId": "string",

  

  

"applyToIdpInstanceId": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateProAuthGroupRoleBatch

POST

/api/management/v2/ProAuthGroupRole/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"roleType": "string",

  

  

"applyToTenantId": "string",

  

  

"applyToIdpInstanceId": "string",

  

  

"proAuthGroupId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteProAuthGroupRoleBatch

DELETE

/api/management/v2/ProAuthGroupRole/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetProAuthGroupRole

GET

/api/management/v2/ProAuthGroupRole/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"roleType": "string",

  

"applyToTenantId": "string",

  

"applyToIdpInstanceId": "string",

  

"proAuthGroupId": "string",

  

"concurrencyToken": "string"

}

---

UpdateProAuthGroupRole

PUT

/api/management/v2/ProAuthGroupRole/{id}

Request Body

{

  

"id": "string",

  

"roleType": "string",

  

"applyToTenantId": "string",

  

"applyToIdpInstanceId": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"roleType": "string",

  

"applyToTenantId": "string",

  

"applyToIdpInstanceId": "string",

  

"proAuthGroupId": "string",

  

"concurrencyToken": "string"

}

---

DeleteProAuthGroupRole

DELETE

/api/management/v2/ProAuthGroupRole/{id}

Responses

No Content

---

PatchProAuthGroupRole

PATCH

/api/management/v2/ProAuthGroupRole/{id}

Request Body

{

  

"roleType": null,

  

"applyToTenantId": null,

  

"applyToIdpInstanceId": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"roleType": "string",

  

"applyToTenantId": "string",

  

"applyToIdpInstanceId": "string",

  

"proAuthGroupId": "string",

  

"concurrencyToken": "string"

}

---

GetProAuthGroupRolesByGroup

GET

/api/management/v2/ProAuthGroupRole/proauthgroup/{proAuthGroupId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"roleType": "string",

  

  

"applyToTenantId": "string",

  

  

"applyToIdpInstanceId": "string",

  

  

"proAuthGroupId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

ProAuthPermission

Operations

GET/api/management/v2/ProAuthPermissionPOST/api/management/v2/ProAuthPermissionGET/api/management/v2/ProAuthPermission/{id}PUT/api/management/v2/ProAuthPermission/{id}DELETE/api/management/v2/ProAuthPermission/{id}PATCH/api/management/v2/ProAuthPermission/{id}PUT/api/management/v2/ProAuthPermission/batchPOST/api/management/v2/ProAuthPermission/batchDELETE/api/management/v2/ProAuthPermission/batch

---

GetProAuthPermissions

GET

/api/management/v2/ProAuthPermission

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"resource": "string",

  

  

"action": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateProAuthPermission

POST

/api/management/v2/ProAuthPermission

Request Body

{

  

"id": "string",

  

"resource": "string",

  

"action": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"resource": "string",

  

"action": "string",

  

"concurrencyToken": "string"

}

---

GetProAuthPermission

GET

/api/management/v2/ProAuthPermission/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"resource": "string",

  

"action": "string",

  

"concurrencyToken": "string"

}

---

UpdateProAuthPermission

PUT

/api/management/v2/ProAuthPermission/{id}

Request Body

{

  

"id": "string",

  

"resource": "string",

  

"action": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"resource": "string",

  

"action": "string",

  

"concurrencyToken": "string"

}

---

DeleteProAuthPermission

DELETE

/api/management/v2/ProAuthPermission/{id}

Responses

No Content

---

PatchProAuthPermission

PATCH

/api/management/v2/ProAuthPermission/{id}

Request Body

{

  

"id": "string",

  

"resource": "string",

  

"action": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"resource": "string",

  

"action": "string",

  

"concurrencyToken": "string"

}

---

UpdateProAuthPermissions

PUT

/api/management/v2/ProAuthPermission/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"resource": "string",

  

  

"action": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateProAuthPermissions

POST

/api/management/v2/ProAuthPermission/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"resource": "string",

  

  

"action": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteProAuthPermissions

DELETE

/api/management/v2/ProAuthPermission/batch

Request Body

[

  

"string"

]

Responses

No Content

---

ProAuthRoleAssignment

Operations

GET/api/management/v2/ProAuthRoleAssignmentPOST/api/management/v2/ProAuthRoleAssignmentGET/api/management/v2/ProAuthRoleAssignment/{id}DELETE/api/management/v2/ProAuthRoleAssignment/{id}POST/api/management/v2/ProAuthRoleAssignment/batchDELETE/api/management/v2/ProAuthRoleAssignment/batch

---

GetProAuthRoleAssignments

GET

/api/management/v2/ProAuthRoleAssignment

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"principalId": "string",

  

  

"principalType": "string",

  

  

"roleId": "string",

  

  

"roleName": "string",

  

  

"scope": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateProAuthRoleAssignment

POST

/api/management/v2/ProAuthRoleAssignment

Request Body

{

  

"id": "string",

  

"principalId": "string",

  

"principalType": "string",

  

"roleId": "string",

  

"roleName": "string",

  

"scope": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"principalId": "string",

  

"principalType": "string",

  

"roleId": "string",

  

"roleName": "string",

  

"scope": "string",

  

"concurrencyToken": "string"

}

---

GetProAuthRoleAssignment

GET

/api/management/v2/ProAuthRoleAssignment/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"principalId": "string",

  

"principalType": "string",

  

"roleId": "string",

  

"roleName": "string",

  

"scope": "string",

  

"concurrencyToken": "string"

}

---

DeleteProAuthRoleAssignment

DELETE

/api/management/v2/ProAuthRoleAssignment/{id}

Responses

No Content

---

CreateProAuthRoleAssignments

POST

/api/management/v2/ProAuthRoleAssignment/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"principalId": "string",

  

  

"principalType": "string",

  

  

"roleId": "string",

  

  

"roleName": "string",

  

  

"scope": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteProAuthRoleAssignments

DELETE

/api/management/v2/ProAuthRoleAssignment/batch

Request Body

[

  

"string"

]

Responses

No Content

---

ProAuthRole

Operations

GET/api/management/v2/ProAuthRolePOST/api/management/v2/ProAuthRoleGET/api/management/v2/ProAuthRole/{id}PUT/api/management/v2/ProAuthRole/{id}DELETE/api/management/v2/ProAuthRole/{id}PATCH/api/management/v2/ProAuthRole/{id}GET/api/management/v2/ProAuthRole/systemPUT/api/management/v2/ProAuthRole/batchPOST/api/management/v2/ProAuthRole/batchDELETE/api/management/v2/ProAuthRole/batch

---

GetProAuthRoles

GET

/api/management/v2/ProAuthRole

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"isSystemDefined": true,

  

  

"concurrencyToken": "string"

  

}

]

---

CreateProAuthRole

POST

/api/management/v2/ProAuthRole

Request Body

{

  

"id": "string",

  

"name": "string",

  

"description": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"isSystemDefined": true,

  

"concurrencyToken": "string"

}

---

GetProAuthRole

GET

/api/management/v2/ProAuthRole/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"isSystemDefined": true,

  

"concurrencyToken": "string"

}

---

UpdateProAuthRole

PUT

/api/management/v2/ProAuthRole/{id}

Request Body

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"isSystemDefined": true,

  

"concurrencyToken": "string"

}

---

DeleteProAuthRole

DELETE

/api/management/v2/ProAuthRole/{id}

Responses

No Content

---

PatchProAuthRole

PATCH

/api/management/v2/ProAuthRole/{id}

Request Body

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"description": "string",

  

"isSystemDefined": true,

  

"concurrencyToken": "string"

}

---

GetSystemRoles

GET

/api/management/v2/ProAuthRole/system

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"isSystemDefined": true,

  

  

"concurrencyToken": "string"

  

}

]

---

UpdateProAuthRoles

PUT

/api/management/v2/ProAuthRole/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"description": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateProAuthRoles

POST

/api/management/v2/ProAuthRole/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"description": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteProAuthRoles

DELETE

/api/management/v2/ProAuthRole/batch

Request Body

[

  

"string"

]

Responses

No Content

---

ProAuthRolePermission

Operations

GET/api/management/v2/ProAuthRolePermission/{id}PUT/api/management/v2/ProAuthRolePermission/{id}DELETE/api/management/v2/ProAuthRolePermission/{id}PATCH/api/management/v2/ProAuthRolePermission/{id}GET/api/management/v2/ProAuthRolePermissionPOST/api/management/v2/ProAuthRolePermissionPOST/api/management/v2/ProAuthRolePermission/batch

---

GetProAuthRolePermission

GET

/api/management/v2/ProAuthRolePermission/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"proAuthRoleId": "string",

  

"proAuthPermissionId": "string",

  

"conditionType": "string",

  

"conditionParameters": "string",

  

"concurrencyToken": "string"

}

---

UpdateProAuthRolePermission

PUT

/api/management/v2/ProAuthRolePermission/{id}

Request Body

{

  

"id": "string",

  

"conditionType": "string",

  

"conditionParameters": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"proAuthRoleId": "string",

  

"proAuthPermissionId": "string",

  

"conditionType": "string",

  

"conditionParameters": "string",

  

"concurrencyToken": "string"

}

---

DeleteProAuthRolePermission

DELETE

/api/management/v2/ProAuthRolePermission/{id}

Responses

No Content

---

PatchProAuthRolePermission

PATCH

/api/management/v2/ProAuthRolePermission/{id}

Request Body

{

  

"id": "string",

  

"conditionType": "string",

  

"conditionParameters": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"proAuthRoleId": "string",

  

"proAuthPermissionId": "string",

  

"conditionType": "string",

  

"conditionParameters": "string",

  

"concurrencyToken": "string"

}

---

GetProAuthRolePermissions

GET

/api/management/v2/ProAuthRolePermission

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"proAuthRoleId": "string",

  

  

"proAuthPermissionId": "string",

  

  

"conditionType": "string",

  

  

"conditionParameters": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateProAuthRolePermission

POST

/api/management/v2/ProAuthRolePermission

Request Body

{

  

"proAuthRoleId": "string",

  

"proAuthPermissionId": "string",

  

"conditionType": "string",

  

"conditionParameters": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"proAuthRoleId": "string",

  

"proAuthPermissionId": "string",

  

"conditionType": "string",

  

"conditionParameters": "string",

  

"concurrencyToken": "string"

}

---

CreateProAuthRolePermissions

POST

/api/management/v2/ProAuthRolePermission/batch

Request Body

[

  

{

  

  

"proAuthRoleId": "string",

  

  

"proAuthPermissionId": "string",

  

  

"conditionType": "string",

  

  

"conditionParameters": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

ProAuthUser

Operations

GET/api/management/v2/ProAuthUserPOST/api/management/v2/ProAuthUserPUT/api/management/v2/ProAuthUser/batchPOST/api/management/v2/ProAuthUser/batchDELETE/api/management/v2/ProAuthUser/batchGET/api/management/v2/ProAuthUser/{id}PUT/api/management/v2/ProAuthUser/{id}DELETE/api/management/v2/ProAuthUser/{id}PATCH/api/management/v2/ProAuthUser/{id}PUT/api/management/v2/ProAuthUser/{id}/emailaddressPUT/api/management/v2/ProAuthUser/{userId}/memberofgroupsPOST/api/management/v2/ProAuthUser/{userId}/memberofgroupsDELETE/api/management/v2/ProAuthUser/{userId}/memberofgroupsGET/api/management/v2/ProAuthUser/{id}/imagePUT/api/management/v2/ProAuthUser/{id}/imageDELETE/api/management/v2/ProAuthUser/{id}/imageDELETE/api/management/v2/ProAuthUser/all/tenant/{tenantId}DELETE/api/management/v2/ProAuthUser/all/idpInstance/{idpInstanceId}DELETE/api/management/v2/ProAuthUser/all/subscription/{subscriptionId}DELETE/api/management/v2/ProAuthUser/all/subscription/{subscriptionId}/noidpGET/api/management/v2/ProAuthUser/idp/{idpId}/externaluniqueuser/{id}GET/api/management/v2/ProAuthUser/idp/{idpId}/scim/{id}GET/api/management/v2/ProAuthUser/idp/{idpId}/userstore/{id}POST/api/management/v2/ProAuthUser/requestuserdetails/{id}

---

GetProAuthUsers

GET

/api/management/v2/ProAuthUser

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"isUserActive": true,

  

  

"loginName": "string",

  

  

"firstName": "string",

  

  

"lastName": "string",

  

  

"emailAddress": "string",

  

  

"emailAddressConfirmed": true,

  

  

"phoneNumber": "string",

  

  

"phoneNumberConfirmed": true,

  

  

"organizationalUnit": "string",

  

  

"middleName": "string",

  

  

"nickname": "string",

  

  

"profile": "string",

  

  

"picture": "string",

  

  

"website": "string",

  

  

"gender": "string",

  

  

"birthdate": "string",

  

  

"zoneinfo": "string",

  

  

"locale": "string",

  

  

"requestUserDetailsOnNextLogin": true,

  

  

"scimExternalId": "string",

  

  

"scimLoginName": "string",

  

  

"managerId": "string",

  

  

"subscriptionId": "string",

  

  

"idpInstanceId": "string",

  

  

"scimSynchronized": true,

  

  

"invitationPending": true,

  

  

"memberOfGroups": [...],

  

  

"mfaInstances": [...],

  

  

"concurrencyToken": "string"

  

}

]

---

CreateProAuthUser

POST

/api/management/v2/ProAuthUser

Request Body

{

  

"id": "string",

  

"isUserActive": true,

  

"loginName": "string",

  

"firstName": "string",

  

"lastName": "string",

  

"emailAddress": "string",

  

"emailAddressConfirmed": true,

  

"phoneNumber": "string",

  

"phoneNumberConfirmed": true,

  

"organizationalUnit": "string",

  

"middleName": "string",

  

"nickname": "string",

  

"profile": "string",

  

"picture": "string",

  

"website": "string",

  

"gender": "string",

  

"birthdate": "string",

  

"zoneinfo": "string",

  

"locale": "string",

  

"requestUserDetailsOnNextLogin": true,

  

"scimExternalId": "string",

  

"scimLoginName": "string",

  

"managerId": "string",

  

"subscriptionId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"isUserActive": true,

  

"loginName": "string",

  

"firstName": "string",

  

"lastName": "string",

  

"emailAddress": "string",

  

"emailAddressConfirmed": true,

  

"phoneNumber": "string",

  

"phoneNumberConfirmed": true,

  

"organizationalUnit": "string",

  

"middleName": "string",

  

"nickname": "string",

  

"profile": "string",

  

"picture": "string",

  

"website": "string",

  

"gender": "string",

  

"birthdate": "string",

  

"zoneinfo": "string",

  

"locale": "string",

  

"requestUserDetailsOnNextLogin": true,

  

"scimExternalId": "string",

  

"scimLoginName": "string",

  

"managerId": "string",

  

"subscriptionId": "string",

  

"idpInstanceId": "string",

  

"scimSynchronized": true,

  

"invitationPending": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"mfaInstances": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

UpdateProAuthUserBatch

PUT

/api/management/v2/ProAuthUser/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"isUserActive": true,

  

  

"loginName": "string",

  

  

"firstName": "string",

  

  

"lastName": "string",

  

  

"emailAddress": "string",

  

  

"emailAddressConfirmed": true,

  

  

"phoneNumber": "string",

  

  

"phoneNumberConfirmed": true,

  

  

"organizationalUnit": "string",

  

  

"middleName": "string",

  

  

"nickname": "string",

  

  

"profile": "string",

  

  

"picture": "string",

  

  

"website": "string",

  

  

"gender": "string",

  

  

"birthdate": "string",

  

  

"zoneinfo": "string",

  

  

"locale": "string",

  

  

"requestUserDetailsOnNextLogin": true,

  

  

"scimExternalId": "string",

  

  

"scimLoginName": "string",

  

  

"managerId": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateProAuthUserBatch

POST

/api/management/v2/ProAuthUser/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"isUserActive": true,

  

  

"loginName": "string",

  

  

"firstName": "string",

  

  

"lastName": "string",

  

  

"emailAddress": "string",

  

  

"emailAddressConfirmed": true,

  

  

"phoneNumber": "string",

  

  

"phoneNumberConfirmed": true,

  

  

"organizationalUnit": "string",

  

  

"middleName": "string",

  

  

"nickname": "string",

  

  

"profile": "string",

  

  

"picture": "string",

  

  

"website": "string",

  

  

"gender": "string",

  

  

"birthdate": "string",

  

  

"zoneinfo": "string",

  

  

"locale": "string",

  

  

"requestUserDetailsOnNextLogin": true,

  

  

"scimExternalId": "string",

  

  

"scimLoginName": "string",

  

  

"managerId": "string",

  

  

"subscriptionId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteProAuthUserBatch

DELETE

/api/management/v2/ProAuthUser/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetProAuthUser

GET

/api/management/v2/ProAuthUser/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"isUserActive": true,

  

"loginName": "string",

  

"firstName": "string",

  

"lastName": "string",

  

"emailAddress": "string",

  

"emailAddressConfirmed": true,

  

"phoneNumber": "string",

  

"phoneNumberConfirmed": true,

  

"organizationalUnit": "string",

  

"middleName": "string",

  

"nickname": "string",

  

"profile": "string",

  

"picture": "string",

  

"website": "string",

  

"gender": "string",

  

"birthdate": "string",

  

"zoneinfo": "string",

  

"locale": "string",

  

"requestUserDetailsOnNextLogin": true,

  

"scimExternalId": "string",

  

"scimLoginName": "string",

  

"managerId": "string",

  

"subscriptionId": "string",

  

"idpInstanceId": "string",

  

"scimSynchronized": true,

  

"invitationPending": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"mfaInstances": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

UpdateProAuthUser

PUT

/api/management/v2/ProAuthUser/{id}

Request Body

{

  

"id": "string",

  

"isUserActive": true,

  

"loginName": "string",

  

"firstName": "string",

  

"lastName": "string",

  

"emailAddress": "string",

  

"emailAddressConfirmed": true,

  

"phoneNumber": "string",

  

"phoneNumberConfirmed": true,

  

"organizationalUnit": "string",

  

"middleName": "string",

  

"nickname": "string",

  

"profile": "string",

  

"picture": "string",

  

"website": "string",

  

"gender": "string",

  

"birthdate": "string",

  

"zoneinfo": "string",

  

"locale": "string",

  

"requestUserDetailsOnNextLogin": true,

  

"scimExternalId": "string",

  

"scimLoginName": "string",

  

"managerId": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"isUserActive": true,

  

"loginName": "string",

  

"firstName": "string",

  

"lastName": "string",

  

"emailAddress": "string",

  

"emailAddressConfirmed": true,

  

"phoneNumber": "string",

  

"phoneNumberConfirmed": true,

  

"organizationalUnit": "string",

  

"middleName": "string",

  

"nickname": "string",

  

"profile": "string",

  

"picture": "string",

  

"website": "string",

  

"gender": "string",

  

"birthdate": "string",

  

"zoneinfo": "string",

  

"locale": "string",

  

"requestUserDetailsOnNextLogin": true,

  

"scimExternalId": "string",

  

"scimLoginName": "string",

  

"managerId": "string",

  

"subscriptionId": "string",

  

"idpInstanceId": "string",

  

"scimSynchronized": true,

  

"invitationPending": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"mfaInstances": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

DeleteProAuthUser

DELETE

/api/management/v2/ProAuthUser/{id}

Responses

No Content

---

PatchProAuthUser

PATCH

/api/management/v2/ProAuthUser/{id}

Request Body

{

  

"isUserActive": null,

  

"loginName": null,

  

"firstName": null,

  

"lastName": null,

  

"emailAddress": null,

  

"emailAddressConfirmed": null,

  

"phoneNumber": null,

  

"phoneNumberConfirmed": null,

  

"organizationalUnit": null,

  

"middleName": null,

  

"nickname": null,

  

"profile": null,

  

"picture": null,

  

"website": null,

  

"gender": null,

  

"birthdate": null,

  

"zoneinfo": null,

  

"locale": null,

  

"requestUserDetailsOnNextLogin": null,

  

"scimExternalId": null,

  

"scimLoginName": null,

  

"managerId": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"isUserActive": true,

  

"loginName": "string",

  

"firstName": "string",

  

"lastName": "string",

  

"emailAddress": "string",

  

"emailAddressConfirmed": true,

  

"phoneNumber": "string",

  

"phoneNumberConfirmed": true,

  

"organizationalUnit": "string",

  

"middleName": "string",

  

"nickname": "string",

  

"profile": "string",

  

"picture": "string",

  

"website": "string",

  

"gender": "string",

  

"birthdate": "string",

  

"zoneinfo": "string",

  

"locale": "string",

  

"requestUserDetailsOnNextLogin": true,

  

"scimExternalId": "string",

  

"scimLoginName": "string",

  

"managerId": "string",

  

"subscriptionId": "string",

  

"idpInstanceId": "string",

  

"scimSynchronized": true,

  

"invitationPending": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"mfaInstances": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

UpdateProAuthUserEmailAddress

PUT

/api/management/v2/ProAuthUser/{id}/emailaddress

Request Body

{

  

"emailAddress": "string",

  

"emailAddressConfirmed": true,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"isUserActive": true,

  

"loginName": "string",

  

"firstName": "string",

  

"lastName": "string",

  

"emailAddress": "string",

  

"emailAddressConfirmed": true,

  

"phoneNumber": "string",

  

"phoneNumberConfirmed": true,

  

"organizationalUnit": "string",

  

"middleName": "string",

  

"nickname": "string",

  

"profile": "string",

  

"picture": "string",

  

"website": "string",

  

"gender": "string",

  

"birthdate": "string",

  

"zoneinfo": "string",

  

"locale": "string",

  

"requestUserDetailsOnNextLogin": true,

  

"scimExternalId": "string",

  

"scimLoginName": "string",

  

"managerId": "string",

  

"subscriptionId": "string",

  

"idpInstanceId": "string",

  

"scimSynchronized": true,

  

"invitationPending": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"mfaInstances": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

SetProAuthUserMemberOfGroups

PUT

/api/management/v2/ProAuthUser/{userId}/memberofgroups

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"isUserActive": true,

  

"loginName": "string",

  

"firstName": "string",

  

"lastName": "string",

  

"emailAddress": "string",

  

"emailAddressConfirmed": true,

  

"phoneNumber": "string",

  

"phoneNumberConfirmed": true,

  

"organizationalUnit": "string",

  

"middleName": "string",

  

"nickname": "string",

  

"profile": "string",

  

"picture": "string",

  

"website": "string",

  

"gender": "string",

  

"birthdate": "string",

  

"zoneinfo": "string",

  

"locale": "string",

  

"requestUserDetailsOnNextLogin": true,

  

"scimExternalId": "string",

  

"scimLoginName": "string",

  

"managerId": "string",

  

"subscriptionId": "string",

  

"idpInstanceId": "string",

  

"scimSynchronized": true,

  

"invitationPending": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"mfaInstances": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

AddProAuthUserToGroup

POST

/api/management/v2/ProAuthUser/{userId}/memberofgroups

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"isUserActive": true,

  

"loginName": "string",

  

"firstName": "string",

  

"lastName": "string",

  

"emailAddress": "string",

  

"emailAddressConfirmed": true,

  

"phoneNumber": "string",

  

"phoneNumberConfirmed": true,

  

"organizationalUnit": "string",

  

"middleName": "string",

  

"nickname": "string",

  

"profile": "string",

  

"picture": "string",

  

"website": "string",

  

"gender": "string",

  

"birthdate": "string",

  

"zoneinfo": "string",

  

"locale": "string",

  

"requestUserDetailsOnNextLogin": true,

  

"scimExternalId": "string",

  

"scimLoginName": "string",

  

"managerId": "string",

  

"subscriptionId": "string",

  

"idpInstanceId": "string",

  

"scimSynchronized": true,

  

"invitationPending": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"mfaInstances": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

RemoveProAuthUserFromGroup

DELETE

/api/management/v2/ProAuthUser/{userId}/memberofgroups

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"isUserActive": true,

  

"loginName": "string",

  

"firstName": "string",

  

"lastName": "string",

  

"emailAddress": "string",

  

"emailAddressConfirmed": true,

  

"phoneNumber": "string",

  

"phoneNumberConfirmed": true,

  

"organizationalUnit": "string",

  

"middleName": "string",

  

"nickname": "string",

  

"profile": "string",

  

"picture": "string",

  

"website": "string",

  

"gender": "string",

  

"birthdate": "string",

  

"zoneinfo": "string",

  

"locale": "string",

  

"requestUserDetailsOnNextLogin": true,

  

"scimExternalId": "string",

  

"scimLoginName": "string",

  

"managerId": "string",

  

"subscriptionId": "string",

  

"idpInstanceId": "string",

  

"scimSynchronized": true,

  

"invitationPending": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"mfaInstances": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

GetProAuthUserImage

GET

/api/management/v2/ProAuthUser/{id}/image

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"proAuthUserId": "string",

  

"contentType": "string",

  

"sizeBytes": 0,

  

"sha256": "string",

  

"concurrencyToken": "string",

  

"picture": "string"

}

---

SetProAuthUserImage

PUT

/api/management/v2/ProAuthUser/{id}/image

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"proAuthUserId": "string",

  

"contentType": "string",

  

"sizeBytes": 0,

  

"sha256": "string",

  

"concurrencyToken": "string",

  

"picture": "string"

}

---

DeleteProAuthUserImage

DELETE

/api/management/v2/ProAuthUser/{id}/image

Responses

No Content

---

DeleteAllProAuthUsersByTenant

DELETE

/api/management/v2/ProAuthUser/all/tenant/{tenantId}

Responses

Bad Request

Content-Type

application/json

{

  

"type": "string",

  

"title": "string",

  

"status": null,

  

"detail": "string",

  

"instance": "string"

}

---

DeleteAllProAuthUsersByIdp

DELETE

/api/management/v2/ProAuthUser/all/idpInstance/{idpInstanceId}

Responses

Bad Request

Content-Type

application/json

{

  

"type": "string",

  

"title": "string",

  

"status": null,

  

"detail": "string",

  

"instance": "string"

}

---

DeleteAllProAuthUsersBySubscription

DELETE

/api/management/v2/ProAuthUser/all/subscription/{subscriptionId}

Responses

Bad Request

Content-Type

application/json

{

  

"type": "string",

  

"title": "string",

  

"status": null,

  

"detail": "string",

  

"instance": "string"

}

---

DeleteAllProAuthUsersWithoutAssignedIdpOfSubscription

DELETE

/api/management/v2/ProAuthUser/all/subscription/{subscriptionId}/noidp

Responses

Bad Request

Content-Type

application/json

{

  

"type": "string",

  

"title": "string",

  

"status": null,

  

"detail": "string",

  

"instance": "string"

}

---

GetProAuthUserByExternalUniqueUserId

GET

/api/management/v2/ProAuthUser/idp/{idpId}/externaluniqueuser/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"isUserActive": true,

  

"loginName": "string",

  

"firstName": "string",

  

"lastName": "string",

  

"emailAddress": "string",

  

"emailAddressConfirmed": true,

  

"phoneNumber": "string",

  

"phoneNumberConfirmed": true,

  

"organizationalUnit": "string",

  

"middleName": "string",

  

"nickname": "string",

  

"profile": "string",

  

"picture": "string",

  

"website": "string",

  

"gender": "string",

  

"birthdate": "string",

  

"zoneinfo": "string",

  

"locale": "string",

  

"requestUserDetailsOnNextLogin": true,

  

"scimExternalId": "string",

  

"scimLoginName": "string",

  

"managerId": "string",

  

"subscriptionId": "string",

  

"idpInstanceId": "string",

  

"scimSynchronized": true,

  

"invitationPending": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"mfaInstances": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

GetScimSynchronizedProAuthUserByScimId

GET

/api/management/v2/ProAuthUser/idp/{idpId}/scim/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"isUserActive": true,

  

"loginName": "string",

  

"firstName": "string",

  

"lastName": "string",

  

"emailAddress": "string",

  

"emailAddressConfirmed": true,

  

"phoneNumber": "string",

  

"phoneNumberConfirmed": true,

  

"organizationalUnit": "string",

  

"middleName": "string",

  

"nickname": "string",

  

"profile": "string",

  

"picture": "string",

  

"website": "string",

  

"gender": "string",

  

"birthdate": "string",

  

"zoneinfo": "string",

  

"locale": "string",

  

"requestUserDetailsOnNextLogin": true,

  

"scimExternalId": "string",

  

"scimLoginName": "string",

  

"managerId": "string",

  

"subscriptionId": "string",

  

"idpInstanceId": "string",

  

"scimSynchronized": true,

  

"invitationPending": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"mfaInstances": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

GetSynchronizedProAuthUserByUserStoreId

GET

/api/management/v2/ProAuthUser/idp/{idpId}/userstore/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"isUserActive": true,

  

"loginName": "string",

  

"firstName": "string",

  

"lastName": "string",

  

"emailAddress": "string",

  

"emailAddressConfirmed": true,

  

"phoneNumber": "string",

  

"phoneNumberConfirmed": true,

  

"organizationalUnit": "string",

  

"middleName": "string",

  

"nickname": "string",

  

"profile": "string",

  

"picture": "string",

  

"website": "string",

  

"gender": "string",

  

"birthdate": "string",

  

"zoneinfo": "string",

  

"locale": "string",

  

"requestUserDetailsOnNextLogin": true,

  

"scimExternalId": "string",

  

"scimLoginName": "string",

  

"managerId": "string",

  

"subscriptionId": "string",

  

"idpInstanceId": "string",

  

"scimSynchronized": true,

  

"invitationPending": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"mfaInstances": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

SetProAuthUserRequestUserDetails

POST

/api/management/v2/ProAuthUser/requestuserdetails/{id}

Responses

Bad Request

Content-Type

application/json

{

  

"type": "string",

  

"title": "string",

  

"status": null,

  

"detail": "string",

  

"instance": "string"

}

---

ProAuthUserFederatedConfiguration

Operations

GET/api/management/v2/ProAuthUserFederatedConfiguration/{id}GET/api/management/v2/ProAuthUserFederatedConfiguration

---

GetProAuthUserFederatedConfiguration

GET

/api/management/v2/ProAuthUserFederatedConfiguration/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"issuer": "string",

  

"subject": "string",

  

"proAuthUserId": "string",

  

"idpInstanceId": "string",

  

"isInternalFederation": true,

  

"isFederatedThroughIdpInstance": true,

  

"lifecycleStatus": "string",

  

"activatedOn": "string",

  

"retiredOn": "string",

  

"replacedIdentityId": "string",

  

"lifecycleReason": "string",

  

"concurrencyToken": "string"

}

---

GetProAuthUserFederatedConfigurations

GET

/api/management/v2/ProAuthUserFederatedConfiguration

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"issuer": "string",

  

  

"subject": "string",

  

  

"proAuthUserId": "string",

  

  

"idpInstanceId": "string",

  

  

"isInternalFederation": true,

  

  

"isFederatedThroughIdpInstance": true,

  

  

"lifecycleStatus": "string",

  

  

"activatedOn": "string",

  

  

"retiredOn": "string",

  

  

"replacedIdentityId": "string",

  

  

"lifecycleReason": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

ProAuthUserInvitation

Operations

GET/api/management/v2/ProAuthUserInvitationGET/api/management/v2/ProAuthUserInvitation/{id}POST/api/management/v2/ProAuthUserInvitation/invitePOST/api/management/v2/ProAuthUserInvitation/invite/send/{id}POST/api/management/v2/ProAuthUserInvitation/{id}/cancel

---

GetProAuthUserInvitations

GET

/api/management/v2/ProAuthUserInvitation

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"status": "string",

  

  

"issuedOn": "string",

  

  

"expiresOn": "string",

  

  

"consumedOn": "string",

  

  

"selectedIdpInstanceId": "string",

  

  

"firstName": "string",

  

  

"lastName": "string",

  

  

"emailAddress": "string",

  

  

"isUserActive": true,

  

  

"subscriptionId": "string",

  

  

"tenantId": "string"

  

}

]

---

GetProAuthUserInvitation

GET

/api/management/v2/ProAuthUserInvitation/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"status": "string",

  

"issuedOn": "string",

  

"expiresOn": "string",

  

"consumedOn": "string",

  

"selectedIdpInstanceId": "string",

  

"firstName": "string",

  

"lastName": "string",

  

"emailAddress": "string",

  

"isUserActive": true,

  

"subscriptionId": "string",

  

"tenantId": "string"

}

---

CreateInvitation

POST

/api/management/v2/ProAuthUserInvitation/invite

Request Body

{

  

"firstName": "string",

  

"lastName": "string",

  

"emailAddress": "string",

  

"isUserActive": true,

  

"subscriptionId": "string",

  

"tenantId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"status": "string",

  

"issuedOn": "string",

  

"expiresOn": "string",

  

"consumedOn": "string",

  

"selectedIdpInstanceId": "string",

  

"firstName": "string",

  

"lastName": "string",

  

"emailAddress": "string",

  

"isUserActive": true,

  

"subscriptionId": "string",

  

"tenantId": "string"

}

---

SendInvitation

POST

/api/management/v2/ProAuthUserInvitation/invite/send/{id}

Responses

OK

Content-Type

application/json

true

---

CancelInvitation

POST

/api/management/v2/ProAuthUserInvitation/{id}/cancel

Responses

OK

Content-Type

application/json

true

---

ProAuthUserMfaFactor

Operations

GET/api/management/v2/ProAuthUserMfaFactor/{id}PUT/api/management/v2/ProAuthUserMfaFactor/{id}DELETE/api/management/v2/ProAuthUserMfaFactor/{id}PATCH/api/management/v2/ProAuthUserMfaFactor/{id}GET/api/management/v2/ProAuthUserMfaFactorPOST/api/management/v2/ProAuthUserMfaFactorPUT/api/management/v2/ProAuthUserMfaFactor/batchPOST/api/management/v2/ProAuthUserMfaFactor/batchDELETE/api/management/v2/ProAuthUserMfaFactor/batchGET/api/management/v2/ProAuthUserMfaFactor/proAuthUser/{proAuthUserId}/type/{mfaFactorType}GET/api/management/v2/ProAuthUserMfaFactor/proAuthUser/{proAuthUserId}GET/api/management/v2/ProAuthUserMfaFactor/proAuthUser/{proAuthUserId}/recoverycodePOST/api/management/v2/ProAuthUserMfaFactor/proAuthUser/{proAuthUserId}/recoverycode

---

GetProAuthUserMfaFactor

GET

/api/management/v2/ProAuthUserMfaFactor/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"mfaFactorType": "string",

  

"mfaFactorValue": "string",

  

"confirmed": true,

  

"confirmationCodeExpiration": "string",

  

"proAuthUserId": "string",

  

"concurrencyToken": "string"

}

---

UpdateProAuthUserMfaFactor

PUT

/api/management/v2/ProAuthUserMfaFactor/{id}

Request Body

{

  

"id": "string",

  

"mfaFactorType": "string",

  

"mfaFactorValue": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"mfaFactorType": "string",

  

"mfaFactorValue": "string",

  

"confirmed": true,

  

"confirmationCodeExpiration": "string",

  

"proAuthUserId": "string",

  

"concurrencyToken": "string"

}

---

DeleteProAuthUserMfaFactor

DELETE

/api/management/v2/ProAuthUserMfaFactor/{id}

Responses

No Content

---

PatchProAuthUserMfaFactor

PATCH

/api/management/v2/ProAuthUserMfaFactor/{id}

Request Body

{

  

"mfaFactorType": null,

  

"mfaFactorValue": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"mfaFactorType": "string",

  

"mfaFactorValue": "string",

  

"confirmed": true,

  

"confirmationCodeExpiration": "string",

  

"proAuthUserId": "string",

  

"concurrencyToken": "string"

}

---

GetProAuthUserMfaFactors

GET

/api/management/v2/ProAuthUserMfaFactor

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"mfaFactorType": "string",

  

  

"mfaFactorValue": "string",

  

  

"confirmed": true,

  

  

"confirmationCodeExpiration": "string",

  

  

"proAuthUserId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateProAuthUserMfaFactor

POST

/api/management/v2/ProAuthUserMfaFactor

Request Body

{

  

"id": "string",

  

"mfaFactorType": "string",

  

"mfaFactorValue": "string",

  

"proAuthUserId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"mfaFactorType": "string",

  

"mfaFactorValue": "string",

  

"confirmed": true,

  

"confirmationCodeExpiration": "string",

  

"proAuthUserId": "string",

  

"concurrencyToken": "string"

}

---

UpdateProAuthUserMfaFactorBatch

PUT

/api/management/v2/ProAuthUserMfaFactor/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"mfaFactorType": "string",

  

  

"mfaFactorValue": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateProAuthUserMfaFactorBatch

POST

/api/management/v2/ProAuthUserMfaFactor/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"mfaFactorType": "string",

  

  

"mfaFactorValue": "string",

  

  

"proAuthUserId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteProAuthUserMfaFactorBatch

DELETE

/api/management/v2/ProAuthUserMfaFactor/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetMfaFactorByType

GET

/api/management/v2/ProAuthUserMfaFactor/proAuthUser/{proAuthUserId}/type/{mfaFactorType}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"mfaFactorType": "string",

  

"mfaFactorValue": "string",

  

"confirmed": true,

  

"confirmationCodeExpiration": "string",

  

"proAuthUserId": "string",

  

"concurrencyToken": "string"

}

---

GetMfaFactorsByProAuthUserId

GET

/api/management/v2/ProAuthUserMfaFactor/proAuthUser/{proAuthUserId}

Responses

OK

Content-Type

application/json

[

]

---

GetMfaRecoveryCodeSet

GET

/api/management/v2/ProAuthUserMfaFactor/proAuthUser/{proAuthUserId}/recoverycode

Responses

OK

Content-Type

application/json

[

]

---

CreateMfaRecoveryCodes

POST

/api/management/v2/ProAuthUserMfaFactor/proAuthUser/{proAuthUserId}/recoverycode

Responses

Created

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"recoveryCode": "string",

  

  

"recoveryGroup": "string",

  

  

"redeemed": true,

  

  

"redeemTimeStamp": "string",

  

  

"invalidated": true,

  

  

"invalidatedTimeStamp": "string",

  

  

"proAuthUserId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

ProAuthUserProfile

Operations

GET/api/management/v2/ProAuthUserProfile/{parentId}POST/api/management/v2/ProAuthUserProfile/{parentId}GET/api/management/v2/ProAuthUserProfile/{parentId}/{key}PUT/api/management/v2/ProAuthUserProfile/{parentId}/{key}DELETE/api/management/v2/ProAuthUserProfile/{parentId}/{key}

---

GetProAuthUserProfiles

GET

/api/management/v2/ProAuthUserProfile/{parentId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"proAuthUserId": "string",

  

  

"key": "string",

  

  

"value": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateProAuthUserProfile

POST

/api/management/v2/ProAuthUserProfile/{parentId}

Request Body

{

  

"proAuthUserId": "string",

  

"key": "string",

  

"value": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"isUserActive": true,

  

"loginName": "string",

  

"firstName": "string",

  

"lastName": "string",

  

"emailAddress": "string",

  

"emailAddressConfirmed": true,

  

"phoneNumber": "string",

  

"phoneNumberConfirmed": true,

  

"organizationalUnit": "string",

  

"middleName": "string",

  

"nickname": "string",

  

"profile": "string",

  

"picture": "string",

  

"website": "string",

  

"gender": "string",

  

"birthdate": "string",

  

"zoneinfo": "string",

  

"locale": "string",

  

"requestUserDetailsOnNextLogin": true,

  

"scimExternalId": "string",

  

"scimLoginName": "string",

  

"managerId": "string",

  

"subscriptionId": "string",

  

"idpInstanceId": "string",

  

"scimSynchronized": true,

  

"invitationPending": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"mfaInstances": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

GetProAuthUserProfile

GET

/api/management/v2/ProAuthUserProfile/{parentId}/{key}

Responses

OK

Content-Type

application/json

{

  

"proAuthUserId": "string",

  

"key": "string",

  

"value": "string",

  

"concurrencyToken": "string"

}

---

UpdateProAuthUserProfile

PUT

/api/management/v2/ProAuthUserProfile/{parentId}/{key}

Request Body

{

  

"value": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"isUserActive": true,

  

"loginName": "string",

  

"firstName": "string",

  

"lastName": "string",

  

"emailAddress": "string",

  

"emailAddressConfirmed": true,

  

"phoneNumber": "string",

  

"phoneNumberConfirmed": true,

  

"organizationalUnit": "string",

  

"middleName": "string",

  

"nickname": "string",

  

"profile": "string",

  

"picture": "string",

  

"website": "string",

  

"gender": "string",

  

"birthdate": "string",

  

"zoneinfo": "string",

  

"locale": "string",

  

"requestUserDetailsOnNextLogin": true,

  

"scimExternalId": "string",

  

"scimLoginName": "string",

  

"managerId": "string",

  

"subscriptionId": "string",

  

"idpInstanceId": "string",

  

"scimSynchronized": true,

  

"invitationPending": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"mfaInstances": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

DeleteProAuthUserProfile

DELETE

/api/management/v2/ProAuthUserProfile/{parentId}/{key}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"isUserActive": true,

  

"loginName": "string",

  

"firstName": "string",

  

"lastName": "string",

  

"emailAddress": "string",

  

"emailAddressConfirmed": true,

  

"phoneNumber": "string",

  

"phoneNumberConfirmed": true,

  

"organizationalUnit": "string",

  

"middleName": "string",

  

"nickname": "string",

  

"profile": "string",

  

"picture": "string",

  

"website": "string",

  

"gender": "string",

  

"birthdate": "string",

  

"zoneinfo": "string",

  

"locale": "string",

  

"requestUserDetailsOnNextLogin": true,

  

"scimExternalId": "string",

  

"scimLoginName": "string",

  

"managerId": "string",

  

"subscriptionId": "string",

  

"idpInstanceId": "string",

  

"scimSynchronized": true,

  

"invitationPending": true,

  

"memberOfGroups": [

  

  

{...}

  

],

  

"mfaInstances": [

  

  

{...}

  

],

  

"concurrencyToken": "string"

}

---

ProAuthUserQuestionnaire

Operations

GET/api/management/v2/ProAuthUserQuestionnairePOST/api/management/v2/ProAuthUserQuestionnairePUT/api/management/v2/ProAuthUserQuestionnaire/batchPOST/api/management/v2/ProAuthUserQuestionnaire/batchDELETE/api/management/v2/ProAuthUserQuestionnaire/batchGET/api/management/v2/ProAuthUserQuestionnaire/{id}PUT/api/management/v2/ProAuthUserQuestionnaire/{id}DELETE/api/management/v2/ProAuthUserQuestionnaire/{id}PATCH/api/management/v2/ProAuthUserQuestionnaire/{id}

---

GetProAuthUserQuestionnaires

GET

/api/management/v2/ProAuthUserQuestionnaire

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"isActive": true,

  

  

"applyToType": "string",

  

  

"subscriptionId": "string",

  

  

"applyToSubscriptionId": "string",

  

  

"applyToTenantId": "string",

  

  

"applyToClientAppId": "string",

  

  

"applyToIdpTypeId": "string",

  

  

"applyToIdpInstanceId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateProAuthUserQuestionnaire

POST

/api/management/v2/ProAuthUserQuestionnaire

Request Body

{

  

"id": "string",

  

"name": "string",

  

"isActive": true,

  

"subscriptionId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"applyToClientAppId": "string",

  

"applyToIdpTypeId": "string",

  

"applyToIdpInstanceId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"isActive": true,

  

"applyToType": "string",

  

"subscriptionId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"applyToClientAppId": "string",

  

"applyToIdpTypeId": "string",

  

"applyToIdpInstanceId": "string",

  

"concurrencyToken": "string"

}

---

UpdateProAuthUserQuestionnaireBatch

PUT

/api/management/v2/ProAuthUserQuestionnaire/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"isActive": true,

  

  

"applyToSubscriptionId": "string",

  

  

"applyToTenantId": "string",

  

  

"applyToClientAppId": "string",

  

  

"applyToIdpTypeId": "string",

  

  

"applyToIdpInstanceId": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateProAuthUserQuestionnaireBatch

POST

/api/management/v2/ProAuthUserQuestionnaire/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"isActive": true,

  

  

"subscriptionId": "string",

  

  

"applyToSubscriptionId": "string",

  

  

"applyToTenantId": "string",

  

  

"applyToClientAppId": "string",

  

  

"applyToIdpTypeId": "string",

  

  

"applyToIdpInstanceId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteProAuthUserQuestionnaireBatch

DELETE

/api/management/v2/ProAuthUserQuestionnaire/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetProAuthUserQuestionnaire

GET

/api/management/v2/ProAuthUserQuestionnaire/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"isActive": true,

  

"applyToType": "string",

  

"subscriptionId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"applyToClientAppId": "string",

  

"applyToIdpTypeId": "string",

  

"applyToIdpInstanceId": "string",

  

"concurrencyToken": "string"

}

---

UpdateProAuthUserQuestionnaire

PUT

/api/management/v2/ProAuthUserQuestionnaire/{id}

Request Body

{

  

"id": "string",

  

"name": "string",

  

"isActive": true,

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"applyToClientAppId": "string",

  

"applyToIdpTypeId": "string",

  

"applyToIdpInstanceId": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"isActive": true,

  

"applyToType": "string",

  

"subscriptionId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"applyToClientAppId": "string",

  

"applyToIdpTypeId": "string",

  

"applyToIdpInstanceId": "string",

  

"concurrencyToken": "string"

}

---

DeleteProAuthUserQuestionnaire

DELETE

/api/management/v2/ProAuthUserQuestionnaire/{id}

Responses

No Content

---

PatchProAuthUserQuestionnaire

PATCH

/api/management/v2/ProAuthUserQuestionnaire/{id}

Request Body

{

  

"name": null,

  

"isActive": null,

  

"applyToSubscriptionId": null,

  

"applyToTenantId": null,

  

"applyToClientAppId": null,

  

"applyToIdpTypeId": null,

  

"applyToIdpInstanceId": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"isActive": true,

  

"applyToType": "string",

  

"subscriptionId": "string",

  

"applyToSubscriptionId": "string",

  

"applyToTenantId": "string",

  

"applyToClientAppId": "string",

  

"applyToIdpTypeId": "string",

  

"applyToIdpInstanceId": "string",

  

"concurrencyToken": "string"

}

---

ProAuthUserQuestionnaireItem

Operations

GET/api/management/v2/ProAuthUserQuestionnaireItemPOST/api/management/v2/ProAuthUserQuestionnaireItemPUT/api/management/v2/ProAuthUserQuestionnaireItem/batchPOST/api/management/v2/ProAuthUserQuestionnaireItem/batchDELETE/api/management/v2/ProAuthUserQuestionnaireItem/batchGET/api/management/v2/ProAuthUserQuestionnaireItem/{id}PUT/api/management/v2/ProAuthUserQuestionnaireItem/{id}DELETE/api/management/v2/ProAuthUserQuestionnaireItem/{id}PATCH/api/management/v2/ProAuthUserQuestionnaireItem/{id}

---

GetProAuthUserQuestionnaireItems

GET

/api/management/v2/ProAuthUserQuestionnaireItem

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"position": 0,

  

  

"questionnaireItemType": "string",

  

  

"key": "string",

  

  

"value": "string",

  

  

"labelId": "string",

  

  

"labelPlaceholderId": "string",

  

  

"isRequired": true,

  

  

"minLength": null,

  

  

"maxLength": null,

  

  

"validationFormat": "string",

  

  

"validationPattern": "string",

  

  

"proAuthUserQuestionnaireId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateProAuthUserQuestionnaireItem

POST

/api/management/v2/ProAuthUserQuestionnaireItem

Request Body

{

  

"id": "string",

  

"position": 0,

  

"questionnaireItemType": "string",

  

"key": "string",

  

"value": "string",

  

"labelId": "string",

  

"labelPlaceholderId": "string",

  

"isRequired": true,

  

"minLength": null,

  

"maxLength": null,

  

"validationFormat": "string",

  

"validationPattern": "string",

  

"proAuthUserQuestionnaireId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"position": 0,

  

"questionnaireItemType": "string",

  

"key": "string",

  

"value": "string",

  

"labelId": "string",

  

"labelPlaceholderId": "string",

  

"isRequired": true,

  

"minLength": null,

  

"maxLength": null,

  

"validationFormat": "string",

  

"validationPattern": "string",

  

"proAuthUserQuestionnaireId": "string",

  

"concurrencyToken": "string"

}

---

UpdateProAuthUserQuestionnaireItemBatch

PUT

/api/management/v2/ProAuthUserQuestionnaireItem/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"position": 0,

  

  

"questionnaireItemType": "string",

  

  

"key": "string",

  

  

"value": "string",

  

  

"labelId": "string",

  

  

"labelPlaceholderId": "string",

  

  

"isRequired": true,

  

  

"minLength": null,

  

  

"maxLength": null,

  

  

"validationFormat": "string",

  

  

"validationPattern": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateProAuthUserQuestionnaireItemBatch

POST

/api/management/v2/ProAuthUserQuestionnaireItem/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"position": 0,

  

  

"questionnaireItemType": "string",

  

  

"key": "string",

  

  

"value": "string",

  

  

"labelId": "string",

  

  

"labelPlaceholderId": "string",

  

  

"isRequired": true,

  

  

"minLength": null,

  

  

"maxLength": null,

  

  

"validationFormat": "string",

  

  

"validationPattern": "string",

  

  

"proAuthUserQuestionnaireId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteProAuthUserQuestionnaireItemBatch

DELETE

/api/management/v2/ProAuthUserQuestionnaireItem/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetProAuthUserQuestionnaireItem

GET

/api/management/v2/ProAuthUserQuestionnaireItem/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"position": 0,

  

"questionnaireItemType": "string",

  

"key": "string",

  

"value": "string",

  

"labelId": "string",

  

"labelPlaceholderId": "string",

  

"isRequired": true,

  

"minLength": null,

  

"maxLength": null,

  

"validationFormat": "string",

  

"validationPattern": "string",

  

"proAuthUserQuestionnaireId": "string",

  

"concurrencyToken": "string"

}

---

UpdateProAuthUserQuestionnaireItem

PUT

/api/management/v2/ProAuthUserQuestionnaireItem/{id}

Request Body

{

  

"id": "string",

  

"position": 0,

  

"questionnaireItemType": "string",

  

"key": "string",

  

"value": "string",

  

"labelId": "string",

  

"labelPlaceholderId": "string",

  

"isRequired": true,

  

"minLength": null,

  

"maxLength": null,

  

"validationFormat": "string",

  

"validationPattern": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"position": 0,

  

"questionnaireItemType": "string",

  

"key": "string",

  

"value": "string",

  

"labelId": "string",

  

"labelPlaceholderId": "string",

  

"isRequired": true,

  

"minLength": null,

  

"maxLength": null,

  

"validationFormat": "string",

  

"validationPattern": "string",

  

"proAuthUserQuestionnaireId": "string",

  

"concurrencyToken": "string"

}

---

DeleteProAuthUserQuestionnaireItem

DELETE

/api/management/v2/ProAuthUserQuestionnaireItem/{id}

Responses

No Content

---

PatchProAuthUserQuestionnaireItem

PATCH

/api/management/v2/ProAuthUserQuestionnaireItem/{id}

Request Body

{

  

"position": null,

  

"questionnaireItemType": null,

  

"key": null,

  

"value": null,

  

"labelId": null,

  

"labelPlaceholderId": null,

  

"isRequired": null,

  

"minLength": null,

  

"maxLength": null,

  

"validationFormat": null,

  

"validationPattern": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"position": 0,

  

"questionnaireItemType": "string",

  

"key": "string",

  

"value": "string",

  

"labelId": "string",

  

"labelPlaceholderId": "string",

  

"isRequired": true,

  

"minLength": null,

  

"maxLength": null,

  

"validationFormat": "string",

  

"validationPattern": "string",

  

"proAuthUserQuestionnaireId": "string",

  

"concurrencyToken": "string"

}

---

ProAuthUserRole

Operations

GET/api/management/v2/ProAuthUserRolePOST/api/management/v2/ProAuthUserRolePUT/api/management/v2/ProAuthUserRole/batchPOST/api/management/v2/ProAuthUserRole/batchDELETE/api/management/v2/ProAuthUserRole/batchGET/api/management/v2/ProAuthUserRole/{id}PUT/api/management/v2/ProAuthUserRole/{id}DELETE/api/management/v2/ProAuthUserRole/{id}PATCH/api/management/v2/ProAuthUserRole/{id}GET/api/management/v2/ProAuthUserRole/proauthuser/{proAuthUserId}

---

GetProAuthUserRoles

GET

/api/management/v2/ProAuthUserRole

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"roleType": "string",

  

  

"applyToTenantId": "string",

  

  

"applyToIdpInstanceId": "string",

  

  

"proAuthUserId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateProAuthUserRole

POST

/api/management/v2/ProAuthUserRole

Request Body

{

  

"id": "string",

  

"roleType": "string",

  

"applyToTenantId": "string",

  

"applyToIdpInstanceId": "string",

  

"proAuthUserId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"roleType": "string",

  

"applyToTenantId": "string",

  

"applyToIdpInstanceId": "string",

  

"proAuthUserId": "string",

  

"concurrencyToken": "string"

}

---

UpdateProAuthUserRoleBatch

PUT

/api/management/v2/ProAuthUserRole/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"roleType": "string",

  

  

"applyToTenantId": "string",

  

  

"applyToIdpInstanceId": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateProAuthUserRoleBatch

POST

/api/management/v2/ProAuthUserRole/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"roleType": "string",

  

  

"applyToTenantId": "string",

  

  

"applyToIdpInstanceId": "string",

  

  

"proAuthUserId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteProAuthUserRoleBatch

DELETE

/api/management/v2/ProAuthUserRole/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetProAuthUserRole

GET

/api/management/v2/ProAuthUserRole/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"roleType": "string",

  

"applyToTenantId": "string",

  

"applyToIdpInstanceId": "string",

  

"proAuthUserId": "string",

  

"concurrencyToken": "string"

}

---

UpdateProAuthUserRole

PUT

/api/management/v2/ProAuthUserRole/{id}

Request Body

{

  

"id": "string",

  

"roleType": "string",

  

"applyToTenantId": "string",

  

"applyToIdpInstanceId": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"roleType": "string",

  

"applyToTenantId": "string",

  

"applyToIdpInstanceId": "string",

  

"proAuthUserId": "string",

  

"concurrencyToken": "string"

}

---

DeleteProAuthUserRole

DELETE

/api/management/v2/ProAuthUserRole/{id}

Responses

No Content

---

PatchProAuthUserRole

PATCH

/api/management/v2/ProAuthUserRole/{id}

Request Body

{

  

"roleType": null,

  

"applyToTenantId": null,

  

"applyToIdpInstanceId": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"roleType": "string",

  

"applyToTenantId": "string",

  

"applyToIdpInstanceId": "string",

  

"proAuthUserId": "string",

  

"concurrencyToken": "string"

}

---

GetProAuthUserRolesByUser

GET

/api/management/v2/ProAuthUserRole/proauthuser/{proAuthUserId}

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"roleType": "string",

  

  

"applyToTenantId": "string",

  

  

"applyToIdpInstanceId": "string",

  

  

"proAuthUserId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

ProductInformation

Operations

GET/api/management/v2/ProductInformation

---

GetProductInformation

GET

/api/management/v2/ProductInformation

Responses

OK

Content-Type

{

  

"productVersion": {

  

  

"installedProductVersion": "string"

  

},

  

"productLicense": {

  

  

"id": "string",

  

  

"customer": "string",

  

  

"contactPerson": "string",

  

  

"contactEmail": "string",

  

  

"isTrialLicense": true,

  

  

"proAuthEdition": "string",

  

  

"registeredHosts": [...],

  

  

"productLicenseType": "string",

  

  

"licensedProductVersion": "string",

  

  

"softwareUpgradeExpiration": "string",

  

  

"subscriptionExpiration": "string"

  

}

}

---

Subscription

Operations

GET/api/management/v2/SubscriptionPOST/api/management/v2/SubscriptionPUT/api/management/v2/Subscription/batchPOST/api/management/v2/Subscription/batchDELETE/api/management/v2/Subscription/batchGET/api/management/v2/Subscription/{id}PUT/api/management/v2/Subscription/{id}DELETE/api/management/v2/Subscription/{id}PATCH/api/management/v2/Subscription/{id}

---

GetSubscriptions

GET

/api/management/v2/Subscription

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"status": "string",

  

  

"customerId": "string",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateSubscription

POST

/api/management/v2/Subscription

Request Body

{

  

"id": "string",

  

"name": "string",

  

"status": "string",

  

"customerId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"status": "string",

  

"customerId": "string",

  

"concurrencyToken": "string"

}

---

UpdateSubscriptionBatch

PUT

/api/management/v2/Subscription/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"status": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateSubscriptionBatch

POST

/api/management/v2/Subscription/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"status": "string",

  

  

"customerId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteSubscriptionBatch

DELETE

/api/management/v2/Subscription/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetSubscription

GET

/api/management/v2/Subscription/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"status": "string",

  

"customerId": "string",

  

"concurrencyToken": "string"

}

---

UpdateSubscription

PUT

/api/management/v2/Subscription/{id}

Request Body

{

  

"id": "string",

  

"name": "string",

  

"status": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"status": "string",

  

"customerId": "string",

  

"concurrencyToken": "string"

}

---

DeleteSubscription

DELETE

/api/management/v2/Subscription/{id}

Responses

No Content

---

PatchSubscription

PATCH

/api/management/v2/Subscription/{id}

Request Body

{

  

"name": null,

  

"status": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"status": "string",

  

"customerId": "string",

  

"concurrencyToken": "string"

}

---

Tenant

Operations

GET/api/management/v2/TenantPOST/api/management/v2/TenantPUT/api/management/v2/Tenant/batchPOST/api/management/v2/Tenant/batchDELETE/api/management/v2/Tenant/batchGET/api/management/v2/Tenant/{id}PUT/api/management/v2/Tenant/{id}DELETE/api/management/v2/Tenant/{id}PATCH/api/management/v2/Tenant/{id}PUT/api/management/v2/Tenant/{id}/idpinstancesPOST/api/management/v2/Tenant/{id}/idpinstancesDELETE/api/management/v2/Tenant/{id}/idpinstancesPUT/api/management/v2/Tenant/{id}/mfainstancesPOST/api/management/v2/Tenant/{id}/mfainstancesDELETE/api/management/v2/Tenant/{id}/mfainstancesPUT/api/management/v2/Tenant/{id}/clientappsPOST/api/management/v2/Tenant/{id}/clientappsDELETE/api/management/v2/Tenant/{id}/clientapps

---

GetTenants

GET

/api/management/v2/Tenant

Responses

OK

Content-Type

application/json

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"accessGrantConsent": "string",

  

  

"logoutConsent": "string",

  

  

"tenantKey": "string",

  

  

"hasConfigurationError": true,

  

  

"subscriptionId": "string",

  

  

"idpInstances": [...],

  

  

"mfaInstances": "[Circular Reference]",

  

  

"clientApps": "[Circular Reference]",

  

  

"concurrencyToken": "string"

  

}

]

---

CreateTenant

POST

/api/management/v2/Tenant

Request Body

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"tenantKey": "string",

  

"subscriptionId": "string"

}

Responses

Created

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"tenantKey": "string",

  

"hasConfigurationError": true,

  

"subscriptionId": "string",

  

"idpInstances": [

  

  

{...}

  

],

  

"mfaInstances": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

UpdateTenantBatch

PUT

/api/management/v2/Tenant/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"accessGrantConsent": "string",

  

  

"logoutConsent": "string",

  

  

"tenantKey": "string",

  

  

"concurrencyToken": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

CreateTenantBatch

POST

/api/management/v2/Tenant/batch

Request Body

[

  

{

  

  

"id": "string",

  

  

"name": "string",

  

  

"accessGrantConsent": "string",

  

  

"logoutConsent": "string",

  

  

"tenantKey": "string",

  

  

"subscriptionId": "string"

  

}

]

Responses

OK

Content-Type

application/json

[

]

---

DeleteTenantBatch

DELETE

/api/management/v2/Tenant/batch

Request Body

[

  

"string"

]

Responses

No Content

---

GetTenant

GET

/api/management/v2/Tenant/{id}

Responses

OK

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"tenantKey": "string",

  

"hasConfigurationError": true,

  

"subscriptionId": "string",

  

"idpInstances": [

  

  

{...}

  

],

  

"mfaInstances": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

UpdateTenant

PUT

/api/management/v2/Tenant/{id}

Request Body

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"tenantKey": "string",

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"tenantKey": "string",

  

"hasConfigurationError": true,

  

"subscriptionId": "string",

  

"idpInstances": [

  

  

{...}

  

],

  

"mfaInstances": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

DeleteTenant

DELETE

/api/management/v2/Tenant/{id}

Responses

No Content

---

PatchTenant

PATCH

/api/management/v2/Tenant/{id}

Request Body

{

  

"name": null,

  

"accessGrantConsent": null,

  

"logoutConsent": null,

  

"tenantKey": null,

  

"concurrencyToken": "string"

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"tenantKey": "string",

  

"hasConfigurationError": true,

  

"subscriptionId": "string",

  

"idpInstances": [

  

  

{...}

  

],

  

"mfaInstances": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

SetIdpInstances

PUT

/api/management/v2/Tenant/{id}/idpinstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"tenantKey": "string",

  

"hasConfigurationError": true,

  

"subscriptionId": "string",

  

"idpInstances": [

  

  

{...}

  

],

  

"mfaInstances": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

AddIdpInstance

POST

/api/management/v2/Tenant/{id}/idpinstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"tenantKey": "string",

  

"hasConfigurationError": true,

  

"subscriptionId": "string",

  

"idpInstances": [

  

  

{...}

  

],

  

"mfaInstances": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

RemoveIdpInstance

DELETE

/api/management/v2/Tenant/{id}/idpinstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"tenantKey": "string",

  

"hasConfigurationError": true,

  

"subscriptionId": "string",

  

"idpInstances": [

  

  

{...}

  

],

  

"mfaInstances": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

SetMfaInstances

PUT

/api/management/v2/Tenant/{id}/mfainstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"tenantKey": "string",

  

"hasConfigurationError": true,

  

"subscriptionId": "string",

  

"idpInstances": [

  

  

{...}

  

],

  

"mfaInstances": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

AddMfaInstance

POST

/api/management/v2/Tenant/{id}/mfainstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"tenantKey": "string",

  

"hasConfigurationError": true,

  

"subscriptionId": "string",

  

"idpInstances": [

  

  

{...}

  

],

  

"mfaInstances": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

RemoveMfaInstance

DELETE

/api/management/v2/Tenant/{id}/mfainstances

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"tenantKey": "string",

  

"hasConfigurationError": true,

  

"subscriptionId": "string",

  

"idpInstances": [

  

  

{...}

  

],

  

"mfaInstances": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

SetClientApps

PUT

/api/management/v2/Tenant/{id}/clientapps

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"tenantKey": "string",

  

"hasConfigurationError": true,

  

"subscriptionId": "string",

  

"idpInstances": [

  

  

{...}

  

],

  

"mfaInstances": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

AddClientApp

POST

/api/management/v2/Tenant/{id}/clientapps

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"tenantKey": "string",

  

"hasConfigurationError": true,

  

"subscriptionId": "string",

  

"idpInstances": [

  

  

{...}

  

],

  

"mfaInstances": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

RemoveClientApp

DELETE

/api/management/v2/Tenant/{id}/clientapps

Request Body

{

  

"relatedIds": [

  

  

"string"

  

]

}

Responses

Accepted

Content-Type

application/json

{

  

"id": "string",

  

"name": "string",

  

"accessGrantConsent": "string",

  

"logoutConsent": "string",

  

"tenantKey": "string",

  

"hasConfigurationError": true,

  

"subscriptionId": "string",

  

"idpInstances": [

  

  

{...}

  

],

  

"mfaInstances": "[Circular Reference]",

  

"clientApps": "[Circular Reference]",

  

"concurrencyToken": "string"

}

---

Token

Operations

POST/api/management/v2/Token/revoke/{tokenId}POST/api/management/v2/Token/revoke/user/{id}POST/api/management/v2/Token/revoke/user/{id}/clientapp/{clientId}DELETE/api/management/v2/Token/{tokenId}POST/api/management/v2/Token/prune

---

RevokeToken

POST

/api/management/v2/Token/revoke/{tokenId}

Responses

No Content

---

RevokeAllTokensForProAuthUser

POST

/api/management/v2/Token/revoke/user/{id}

Responses

No Content

---

RevokeAllTokensForProAuthUserAndClientApp

POST

/api/management/v2/Token/revoke/user/{id}/clientapp/{clientId}

Responses

No Content

---

DeleteToken

DELETE

/api/management/v2/Token/{tokenId}

Responses

No Content

---

PruneTokens

POST

/api/management/v2/Token/prune

Responses

OK

---

UnifiedInvitation

Operations

POST/api/management/v2/unified-invitationsGET/api/management/v2/unified-invitations/{id}POST/api/management/v2/unified-invitations/{id}/cancelPOST/api/management/v2/unified-invitations/{id}/remindPOST/api/management/v2/unified-invitations/{id}/reissuePOST/api/management/v2/unified-invitations/{id}/approvalsGET/api/management/v2/unified-invitations/legacy-migration/queueGET/api/management/v2/unified-invitations/legacy-migrationPOST/api/management/v2/unified-invitations/legacy-migration/reissues

---

CreateUnifiedInvitation

POST

/api/management/v2/unified-invitations

Request Body

{

  

"subscriptionId": "string",

  

"tenantId": "string",

  

"clientAppId": "string",

  

"intendedProAuthUserId": "string",

  

"emailAddress": "string",

  

"allowEmailChange": true,

  

"loginName": "string",

  

"allowLoginNameChange": true,

  

"eligibleIdpInstanceIds": [

  

],

  

"lifetimeHours": 0,

  

"policyFingerprint": "string",

  

"requiredApprovals": 0,

  

"authorizedClientAppIds": [

  

],

  

"groupIds": [

  

]

}

Responses

Created

Content-Type

{

  

"id": "string",

  

"subscriptionId": "string",

  

"tenantId": "string",

  

"clientAppId": "string",

  

"intendedProAuthUserId": "string",

  

"emailAddress": "string",

  

"allowEmailChange": true,

  

"loginName": "string",

  

"allowLoginNameChange": true,

  

"status": "string",

  

"issuedOn": "string",

  

"expiresOn": "string",

  

"completedOn": "string",

  

"cancelledOn": "string",

  

"archivedOn": "string",

  

"historyExpiresOn": "string",

  

"cancellationReason": "string",

  

"supersededOn": "string",

  

"supersededByInvitationId": "string",

  

"supersedesInvitationId": "string",

  

"winningRouteId": "string",

  

"reminderCount": 0,

  

"lastReminderOn": "string",

  

"policyFingerprint": "string",

  

"requiredApprovals": 0,

  

"approvedByActorIds": [

  

],

  

"approvalSatisfiedOn": "string",

  

"assignments": [

  

  

{...}

  

],

  

"routes": [

  

  

{...}

  

]

}

---

GetUnifiedInvitation

GET

/api/management/v2/unified-invitations/{id}

Responses

OK

Content-Type

{

  

"id": "string",

  

"subscriptionId": "string",

  

"tenantId": "string",

  

"clientAppId": "string",

  

"intendedProAuthUserId": "string",

  

"emailAddress": "string",

  

"allowEmailChange": true,

  

"loginName": "string",

  

"allowLoginNameChange": true,

  

"status": "string",

  

"issuedOn": "string",

  

"expiresOn": "string",

  

"completedOn": "string",

  

"cancelledOn": "string",

  

"archivedOn": "string",

  

"historyExpiresOn": "string",

  

"cancellationReason": "string",

  

"supersededOn": "string",

  

"supersededByInvitationId": "string",

  

"supersedesInvitationId": "string",

  

"winningRouteId": "string",

  

"reminderCount": 0,

  

"lastReminderOn": "string",

  

"policyFingerprint": "string",

  

"requiredApprovals": 0,

  

"approvedByActorIds": [

  

],

  

"approvalSatisfiedOn": "string",

  

"assignments": [

  

],

  

"routes": [

  

]

}

---

CancelUnifiedInvitation

POST

/api/management/v2/unified-invitations/{id}/cancel

Request Body

{

  

"reason": "string"

}

Responses

No Content

---

Remind

POST

/api/management/v2/unified-invitations/{id}/remind

Responses

Accepted

---

Reissue

POST

/api/management/v2/unified-invitations/{id}/reissue

Request Body

{

  

"lifetimeHours": 0,

  

"reason": "string"

}

Responses

Created

Content-Type

{

  

"id": "string",

  

"subscriptionId": "string",

  

"tenantId": "string",

  

"clientAppId": "string",

  

"intendedProAuthUserId": "string",

  

"emailAddress": "string",

  

"allowEmailChange": true,

  

"loginName": "string",

  

"allowLoginNameChange": true,

  

"status": "string",

  

"issuedOn": "string",

  

"expiresOn": "string",

  

"completedOn": "string",

  

"cancelledOn": "string",

  

"archivedOn": "string",

  

"historyExpiresOn": "string",

  

"cancellationReason": "string",

  

"supersededOn": "string",

  

"supersededByInvitationId": "string",

  

"supersedesInvitationId": "string",

  

"winningRouteId": "string",

  

"reminderCount": 0,

  

"lastReminderOn": "string",

  

"policyFingerprint": "string",

  

"requiredApprovals": 0,

  

"approvedByActorIds": [

  

],

  

"approvalSatisfiedOn": "string",

  

"assignments": [

  

  

{...}

  

],

  

"routes": [

  

  

{...}

  

]

}

---

ApproveUnifiedInvitation

POST

/api/management/v2/unified-invitations/{id}/approvals

Responses

OK

Content-Type

{

  

"invitationId": "string",

  

"requiredApprovals": 0,

  

"approvedByActorIds": [

  

],

  

"satisfied": true,

  

"satisfiedOn": "string"

}

---

ListLegacyInvitations

GET

/api/management/v2/unified-invitations/legacy-migration/queue

Responses

OK

Content-Type

{

  

"items": [

  

  

{...}

  

],

  

"totalCount": 0

}

---

GetLegacyMigrationInventory

GET

/api/management/v2/unified-invitations/legacy-migration

Responses

OK

Content-Type

{

  

"subscriptionId": "string",

  

"tenantId": "string",

  

"items": [

  

  

{...}

  

],

  

"fingerprint": "string"

}

---

ReissueLegacy

POST

/api/management/v2/unified-invitations/legacy-migration/reissues

Request Body

{

  

"subscriptionId": "string",

  

"proAuthUserId": "string",

  

"legacyIdentityId": "string",

  

"tenantId": "string",

  

"clientAppId": "string",

  

"eligibleIdpInstanceIds": [

  

],

  

"lifetimeHours": 0,

  

"policyFingerprint": "string",

  

"previewFingerprint": "string",

  

"requiredApprovals": 0

}

Responses

OK

Content-Type

{

  

"id": "string",

  

"subscriptionId": "string",

  

"tenantId": "string",

  

"clientAppId": "string",

  

"intendedProAuthUserId": "string",

  

"emailAddress": "string",

  

"allowEmailChange": true,

  

"loginName": "string",

  

"allowLoginNameChange": true,

  

"status": "string",

  

"issuedOn": "string",

  

"expiresOn": "string",

  

"completedOn": "string",

  

"cancelledOn": "string",

  

"archivedOn": "string",

  

"historyExpiresOn": "string",

  

"cancellationReason": "string",

  

"supersededOn": "string",

  

"supersededByInvitationId": "string",

  

"supersedesInvitationId": "string",

  

"winningRouteId": "string",

  

"reminderCount": 0,

  

"lastReminderOn": "string",

  

"policyFingerprint": "string",

  

"requiredApprovals": 0,

  

"approvedByActorIds": [

  

],

  

"approvalSatisfiedOn": "string",

  

"assignments": [

  

],

  

"routes": [

  

]

}

---

UserStoreHardeningMigration

Operations

GET/api/management/v2/idpinstances/{idpInstanceId}/userstore-hardening-migrationPOST/api/management/v2/idpinstances/{idpInstanceId}/userstore-hardening-migration/batchesPOST/api/management/v2/idpinstances/{idpInstanceId}/userstore-hardening-migration/activate

---

GetUserStoreHardeningStatus

GET

/api/management/v2/idpinstances/{idpInstanceId}/userstore-hardening-migration

Responses

OK

Content-Type

{

  

"idpInstanceId": "string",

  

"totalUsers": 0,

  

"usersMissingCanonicalIdentifiers": 0,

  

"quarantinedIdentifierConflicts": 0,

  

"confirmedEmailsMissingUnifiedContact": 0,

  

"legacyPasswordResetArtifacts": 0,

  

"backfillComplete": true,

  

"fingerprint": "string"

}

---

RunUserStoreHardeningBatch

POST

/api/management/v2/idpinstances/{idpInstanceId}/userstore-hardening-migration/batches

Request Body

{

  

"batchSize": 0,

  

"allServingNodesCurrentAttestation": true

}

Responses

OK

Content-Type

{

  

"usersProcessed": 0,

  

"canonicalIdentifiersBackfilled": 0,

  

"identifierConflictsQuarantined": 0,

  

"unifiedContactsBackfilled": 0,

  

"legacyResetArtifactsInvalidated": 0,

  

"status": {

  

  

"idpInstanceId": "string",

  

  

"totalUsers": 0,

  

  

"usersMissingCanonicalIdentifiers": 0,

  

  

"quarantinedIdentifierConflicts": 0,

  

  

"confirmedEmailsMissingUnifiedContact": 0,

  

  

"legacyPasswordResetArtifacts": 0,

  

  

"backfillComplete": true,

  

  

"fingerprint": "string"

  

}

}

---

ActivateUserStoreHardening

POST

/api/management/v2/idpinstances/{idpInstanceId}/userstore-hardening-migration/activate

Request Body

{

  

"previewFingerprint": "string",

  

"allServingNodesCurrentAttestation": true,

  

"impactAcknowledgement": "string"

}

Responses

OK

Content-Type

{

  

"idpInstanceId": "string",

  

"fingerprint": "string",

  

"activatedOn": "string",

  

"hardeningMode": "string",

  

"abusePolicyMode": "string"

}

---