Skip to content
Version v3.0.0

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:

Option Metadata Editor Hints

OptionMetadata exposes additive v2 metadata for configuration editors:

FieldDescription
dataTypeDescribes 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.
editorTypeProvides 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.

User Questionnaire Validation

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

FieldDescription
isRequiredIndicates 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 / maxLengthOptional string length constraints. minLength must be less than or equal to maxLength.
validationFormatBuilt-in format validation. Supported values are None, Email, PhoneE164, and Regex.
validationPatternRequired 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.

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.


GetApplicationGroupsByTenant

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

Responses

OK

application/json
JSON
[
  
{
  
  
"id": null,
  
  
"name": "string",
  
  
"concurrencyToken": "string"
  
}
]

GetApplicationGroupsByIdpInstance

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

Responses

OK

application/json
JSON
[
  
{
  
  
"id": null,
  
  
"name": "string",
  
  
"concurrencyToken": "string"
  
}
]

GetApplicationGroup

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

Responses

OK

application/json
JSON
{
  
"id": null,
  
"name": "string",
  
"concurrencyToken": "string"
}

GetApplicationGroups

GET
/api/management/v2/ApplicationGroup

Responses

OK

application/json
JSON
[
  
{
  
  
"id": null,
  
  
"name": "string",
  
  
"concurrencyToken": "string"
  
}
]

GetApplicationUsersByTenant

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

Responses

OK

application/json
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

application/json
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

application/json
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

application/json
JSON
[
  
{
  
  
"id": null,
  
  
"firstName": "string",
  
  
"lastName": "string",
  
  
"emailAddress": "string",
  
  
"organizationalUnit": "string",
  
  
"picture": "string",
  
  
"managerId": null,
  
  
"concurrencyToken": "string"
  
}
]

GetCertStores

GET
/api/management/v2/CertStore

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"certType": 0,
  
  
"certificate": "string",
  
  
"password": "string",
  
  
"thumbprint": "string",
  
  
"validFrom": "string",
  
  
"validTo": "string",
  
  
"issuer": "string",
  
  
"serialNumber": "string",
  
  
"subject": "string",
  
  
"applyToType": 0,
  
  
"subscriptionId": "string",
  
  
"applyToSubscriptionId": "string",
  
  
"applyToTenantId": "string",
  
  
"certificateStorageFormat": "string",
  
  
"certificatePasswordProtection": "string",
  
  
"certificateHasPrivateKey": true,
  
  
"concurrencyToken": "string"
  
}
]

CreateCertStore

POST
/api/management/v2/CertStore

Request Body

JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"certType": 0,
  
"certificate": "string",
  
"password": "string",
  
"certificateInput": null,
  
"certificateStorageFormat": "string",
  
"certificatePasswordProtection": "string",
  
"certificateHasPrivateKey": true,
  
"subscriptionId": "string",
  
"applyToSubscriptionId": "string",
  
"applyToTenantId": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"certType": 0,
  
"certificate": "string",
  
"password": "string",
  
"thumbprint": "string",
  
"validFrom": "string",
  
"validTo": "string",
  
"issuer": "string",
  
"serialNumber": "string",
  
"subject": "string",
  
"applyToType": 0,
  
"subscriptionId": "string",
  
"applyToSubscriptionId": "string",
  
"applyToTenantId": "string",
  
"certificateStorageFormat": "string",
  
"certificatePasswordProtection": "string",
  
"certificateHasPrivateKey": true,
  
"concurrencyToken": "string"
}

UpdateCertStoreBatch

PUT
/api/management/v2/CertStore/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"certType": 0,
  
  
"certificate": "string",
  
  
"password": "string",
  
  
"certificateStorageFormat": "string",
  
  
"certificatePasswordProtection": "string",
  
  
"certificateHasPrivateKey": true,
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateCertStoreBatch

POST
/api/management/v2/CertStore/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"certType": 0,
  
  
"certificate": "string",
  
  
"password": "string",
  
  
"certificateInput": null,
  
  
"certificateStorageFormat": "string",
  
  
"certificatePasswordProtection": "string",
  
  
"certificateHasPrivateKey": true,
  
  
"subscriptionId": "string",
  
  
"applyToSubscriptionId": "string",
  
  
"applyToTenantId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteCertStoreBatch

DELETE
/api/management/v2/CertStore/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetCertStore

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"certType": 0,
  
"certificate": "string",
  
"password": "string",
  
"thumbprint": "string",
  
"validFrom": "string",
  
"validTo": "string",
  
"issuer": "string",
  
"serialNumber": "string",
  
"subject": "string",
  
"applyToType": 0,
  
"subscriptionId": "string",
  
"applyToSubscriptionId": "string",
  
"applyToTenantId": "string",
  
"certificateStorageFormat": "string",
  
"certificatePasswordProtection": "string",
  
"certificateHasPrivateKey": true,
  
"concurrencyToken": "string"
}

UpdateCertStore

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

Request Body

JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"certType": 0,
  
"certificate": "string",
  
"password": "string",
  
"certificateStorageFormat": "string",
  
"certificatePasswordProtection": "string",
  
"certificateHasPrivateKey": true,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"certType": 0,
  
"certificate": "string",
  
"password": "string",
  
"thumbprint": "string",
  
"validFrom": "string",
  
"validTo": "string",
  
"issuer": "string",
  
"serialNumber": "string",
  
"subject": "string",
  
"applyToType": 0,
  
"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

JSON
{
  
"name": null,
  
"description": null,
  
"certType": null,
  
"certificate": null,
  
"password": null,
  
"certificateStorageFormat": null,
  
"certificatePasswordProtection": null,
  
"certificateHasPrivateKey": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"certType": 0,
  
"certificate": "string",
  
"password": "string",
  
"thumbprint": "string",
  
"validFrom": "string",
  
"validTo": "string",
  
"issuer": "string",
  
"serialNumber": "string",
  
"subject": "string",
  
"applyToType": 0,
  
"subscriptionId": "string",
  
"applyToSubscriptionId": "string",
  
"applyToTenantId": "string",
  
"certificateStorageFormat": "string",
  
"certificatePasswordProtection": "string",
  
"certificateHasPrivateKey": true,
  
"concurrencyToken": "string"
}

GetAllByType

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

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"certType": 0,
  
  
"certificate": "string",
  
  
"password": "string",
  
  
"thumbprint": "string",
  
  
"validFrom": "string",
  
  
"validTo": "string",
  
  
"issuer": "string",
  
  
"serialNumber": "string",
  
  
"subject": "string",
  
  
"applyToType": 0,
  
  
"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

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"certType": 0,
  
  
"certificate": "string",
  
  
"password": "string",
  
  
"thumbprint": "string",
  
  
"validFrom": "string",
  
  
"validTo": "string",
  
  
"issuer": "string",
  
  
"serialNumber": "string",
  
  
"subject": "string",
  
  
"applyToType": 0,
  
  
"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

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"certType": 0,
  
  
"certificate": "string",
  
  
"password": "string",
  
  
"thumbprint": "string",
  
  
"validFrom": "string",
  
  
"validTo": "string",
  
  
"issuer": "string",
  
  
"serialNumber": "string",
  
  
"subject": "string",
  
  
"applyToType": 0,
  
  
"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

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"certType": 0,
  
  
"certificate": "string",
  
  
"password": "string",
  
  
"thumbprint": "string",
  
  
"validFrom": "string",
  
  
"validTo": "string",
  
  
"issuer": "string",
  
  
"serialNumber": "string",
  
  
"subject": "string",
  
  
"applyToType": 0,
  
  
"subscriptionId": "string",
  
  
"applyToSubscriptionId": "string",
  
  
"applyToTenantId": "string",
  
  
"certificateStorageFormat": "string",
  
  
"certificatePasswordProtection": "string",
  
  
"certificateHasPrivateKey": true,
  
  
"concurrencyToken": "string"
  
}
]

SetCertStoreIdpInstances

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

Request Body

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"certType": 0,
  
"certificate": "string",
  
"password": "string",
  
"thumbprint": "string",
  
"validFrom": "string",
  
"validTo": "string",
  
"issuer": "string",
  
"serialNumber": "string",
  
"subject": "string",
  
"applyToType": 0,
  
"subscriptionId": "string",
  
"applyToSubscriptionId": "string",
  
"applyToTenantId": "string",
  
"certificateStorageFormat": "string",
  
"certificatePasswordProtection": "string",
  
"certificateHasPrivateKey": true,
  
"concurrencyToken": "string"
}

AddCertStoreIdpInstance

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

Request Body

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"certType": 0,
  
"certificate": "string",
  
"password": "string",
  
"thumbprint": "string",
  
"validFrom": "string",
  
"validTo": "string",
  
"issuer": "string",
  
"serialNumber": "string",
  
"subject": "string",
  
"applyToType": 0,
  
"subscriptionId": "string",
  
"applyToSubscriptionId": "string",
  
"applyToTenantId": "string",
  
"certificateStorageFormat": "string",
  
"certificatePasswordProtection": "string",
  
"certificateHasPrivateKey": true,
  
"concurrencyToken": "string"
}

RemoveCertStoreIdpInstance

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

Request Body

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"certType": 0,
  
"certificate": "string",
  
"password": "string",
  
"thumbprint": "string",
  
"validFrom": "string",
  
"validTo": "string",
  
"issuer": "string",
  
"serialNumber": "string",
  
"subject": "string",
  
"applyToType": 0,
  
"subscriptionId": "string",
  
"applyToSubscriptionId": "string",
  
"applyToTenantId": "string",
  
"certificateStorageFormat": "string",
  
"certificatePasswordProtection": "string",
  
"certificateHasPrivateKey": true,
  
"concurrencyToken": "string"
}

GetClaimRules

GET
/api/management/v2/ClaimRule

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"ruleType": 0,
  
  
"filterTarget": 0,
  
  
"transformTarget": 0,
  
  
"ruleLevel": 0,
  
  
"destination": 0,
  
  
"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

JSON
{
  
"id": "string",
  
"name": "string",
  
"ruleType": 0,
  
"filterTarget": 0,
  
"transformTarget": 0,
  
"ruleLevel": 0,
  
"destination": 0,
  
"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

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"ruleType": 0,
  
"filterTarget": 0,
  
"transformTarget": 0,
  
"ruleLevel": 0,
  
"destination": 0,
  
"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

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"ruleType": 0,
  
  
"filterTarget": 0,
  
  
"transformTarget": 0,
  
  
"ruleLevel": 0,
  
  
"destination": 0,
  
  
"priority": 0,
  
  
"typeEvaluationRule": "string",
  
  
"valueEvaluationRule": "string",
  
  
"typeTransformationRule": "string",
  
  
"valueTransformationRule": "string",
  
  
"typeTransformationReplacement": "string",
  
  
"valueTransformationReplacement": "string",
  
  
"isActive": true,
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateClaimRuleBatch

POST
/api/management/v2/ClaimRule/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"ruleType": 0,
  
  
"filterTarget": 0,
  
  
"transformTarget": 0,
  
  
"ruleLevel": 0,
  
  
"destination": 0,
  
  
"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

application/json
JSON
[
]

DeleteClaimRuleBatch

DELETE
/api/management/v2/ClaimRule/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetClaimRule

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"ruleType": 0,
  
"filterTarget": 0,
  
"transformTarget": 0,
  
"ruleLevel": 0,
  
"destination": 0,
  
"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

JSON
{
  
"id": "string",
  
"name": "string",
  
"ruleType": 0,
  
"filterTarget": 0,
  
"transformTarget": 0,
  
"ruleLevel": 0,
  
"destination": 0,
  
"priority": 0,
  
"typeEvaluationRule": "string",
  
"valueEvaluationRule": "string",
  
"typeTransformationRule": "string",
  
"valueTransformationRule": "string",
  
"typeTransformationReplacement": "string",
  
"valueTransformationReplacement": "string",
  
"isActive": true,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"ruleType": 0,
  
"filterTarget": 0,
  
"transformTarget": 0,
  
"ruleLevel": 0,
  
"destination": 0,
  
"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

JSON
{
  
"name": null,
  
"ruleType": null,
  
"filterTarget": null,
  
"transformTarget": null,
  
"ruleLevel": null,
  
"destination": null,
  
"priority": null,
  
"typeEvaluationRule": null,
  
"valueEvaluationRule": null,
  
"typeTransformationRule": null,
  
"valueTransformationRule": null,
  
"typeTransformationReplacement": null,
  
"valueTransformationReplacement": null,
  
"isActive": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"ruleType": 0,
  
"filterTarget": 0,
  
"transformTarget": 0,
  
"ruleLevel": 0,
  
"destination": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"ruleType": 0,
  
"filterTarget": 0,
  
"transformTarget": 0,
  
"ruleLevel": 0,
  
"destination": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"ruleType": 0,
  
"filterTarget": 0,
  
"transformTarget": 0,
  
"ruleLevel": 0,
  
"destination": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"ruleType": 0,
  
"filterTarget": 0,
  
"transformTarget": 0,
  
"ruleLevel": 0,
  
"destination": 0,
  
"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"
}

GetClientAppAuthenticationConfigurations

GET
/api/management/v2/ClientAppAuthenticationConfiguration

Responses

OK

application/json
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

JSON
{
  
"clientAppId": "string",
  
"tokenEndpointAuthMethod": "string",
  
"requireCertificateBoundAccessTokens": true,
  
"dpopBoundAccessTokens": true,
  
"requireDpopNonce": true,
  
"tlsClientAuthSubjectDn": "string",
  
"tlsClientAuthSanDns": "string",
  
"tlsClientAuthSanUri": "string",
  
"tlsClientAuthSanIp": "string",
  
"tlsClientAuthSanEmail": "string"
}

Responses

Created

application/json
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

application/json
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

JSON
{
  
"tokenEndpointAuthMethod": "string",
  
"requireCertificateBoundAccessTokens": true,
  
"dpopBoundAccessTokens": true,
  
"requireDpopNonce": true,
  
"tlsClientAuthSubjectDn": "string",
  
"tlsClientAuthSanDns": "string",
  
"tlsClientAuthSanUri": "string",
  
"tlsClientAuthSanIp": "string",
  
"tlsClientAuthSanEmail": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"tokenEndpointAuthMethod": "string",
  
"requireCertificateBoundAccessTokens": true,
  
"dpopBoundAccessTokens": true,
  
"requireDpopNonce": true,
  
"tlsClientAuthSubjectDn": "string",
  
"tlsClientAuthSanDns": "string",
  
"tlsClientAuthSanUri": "string",
  
"tlsClientAuthSanIp": "string",
  
"tlsClientAuthSanEmail": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
[
  
{
  
  
"tokenEndpointAuthMethod": "string",
  
  
"requireCertificateBoundAccessTokens": true,
  
  
"dpopBoundAccessTokens": true,
  
  
"requireDpopNonce": true,
  
  
"tlsClientAuthSubjectDn": "string",
  
  
"tlsClientAuthSanDns": "string",
  
  
"tlsClientAuthSanUri": "string",
  
  
"tlsClientAuthSanIp": "string",
  
  
"tlsClientAuthSanEmail": "string",
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateClientAppAuthenticationConfigurations

POST
/api/management/v2/ClientAppAuthenticationConfiguration/batch

Request Body

JSON
[
  
{
  
  
"clientAppId": "string",
  
  
"tokenEndpointAuthMethod": "string",
  
  
"requireCertificateBoundAccessTokens": true,
  
  
"dpopBoundAccessTokens": true,
  
  
"requireDpopNonce": true,
  
  
"tlsClientAuthSubjectDn": "string",
  
  
"tlsClientAuthSanDns": "string",
  
  
"tlsClientAuthSanUri": "string",
  
  
"tlsClientAuthSanIp": "string",
  
  
"tlsClientAuthSanEmail": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteClientAppAuthenticationConfigurations

DELETE
/api/management/v2/ClientAppAuthenticationConfiguration/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


ClientApp

Operations


GetClientApps

GET
/api/management/v2/ClientApp

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"accessGrantConsent": 0,
  
  
"logoutConsent": 0,
  
  
"resourceFilterEnabled": true,
  
  
"scopeFilterEnabled": true,
  
  
"clientUri": "string",
  
  
"logoUri": "string",
  
  
"backchannelLogoutUri": "string",
  
  
"backchannelLogoutSessionRequired": true,
  
  
"frontchannelLogoutUri": "string",
  
  
"frontchannelLogoutSessionRequired": true,
  
  
"enabled": true,
  
  
"isPublic": true,
  
  
"isRestricted": true,
  
  
"includeGroupsClaims": true,
  
  
"allowCrossSubscription": true,
  
  
"allowUserLogin": true,
  
  
"allowClientCredentialLogin": true,
  
  
"accessTokenType": 0,
  
  
"securityProfile": 0,
  
  
"subjectType": 0,
  
  
"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

JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"accessGrantConsent": 0,
  
  
"logoutConsent": 0,
  
  
"resourceFilterEnabled": true,
  
  
"scopeFilterEnabled": true,
  
  
"clientUri": "string",
  
  
"logoUri": "string",
  
  
"backchannelLogoutUri": "string",
  
  
"backchannelLogoutSessionRequired": true,
  
  
"frontchannelLogoutUri": "string",
  
  
"frontchannelLogoutSessionRequired": true,
  
  
"enabled": true,
  
  
"isPublic": true,
  
  
"isRestricted": true,
  
  
"includeGroupsClaims": true,
  
  
"allowCrossSubscription": true,
  
  
"allowUserLogin": true,
  
  
"allowClientCredentialLogin": true,
  
  
"accessTokenType": 0,
  
  
"securityProfile": 0,
  
  
"subjectType": 0,
  
  
"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

application/json
JSON
[
]

CreateClientAppBatch

POST
/api/management/v2/ClientApp/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"accessGrantConsent": 0,
  
  
"logoutConsent": 0,
  
  
"resourceFilterEnabled": true,
  
  
"scopeFilterEnabled": true,
  
  
"clientUri": "string",
  
  
"logoUri": "string",
  
  
"backchannelLogoutUri": "string",
  
  
"backchannelLogoutSessionRequired": true,
  
  
"frontchannelLogoutUri": "string",
  
  
"frontchannelLogoutSessionRequired": true,
  
  
"enabled": true,
  
  
"isPublic": true,
  
  
"isRestricted": true,
  
  
"includeGroupsClaims": true,
  
  
"allowCrossSubscription": true,
  
  
"allowUserLogin": true,
  
  
"allowClientCredentialLogin": true,
  
  
"accessTokenType": 0,
  
  
"securityProfile": 0,
  
  
"subjectType": 0,
  
  
"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

application/json
JSON
[
]

DeleteClientAppBatch

DELETE
/api/management/v2/ClientApp/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetClientApp

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"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,
  
"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

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"accessGrantConsent": 0,
  
  
"logoutConsent": 0,
  
  
"resourceFilterEnabled": true,
  
  
"scopeFilterEnabled": true,
  
  
"clientUri": "string",
  
  
"logoUri": "string",
  
  
"backchannelLogoutUri": "string",
  
  
"backchannelLogoutSessionRequired": true,
  
  
"frontchannelLogoutUri": "string",
  
  
"frontchannelLogoutSessionRequired": true,
  
  
"enabled": true,
  
  
"isPublic": true,
  
  
"isRestricted": true,
  
  
"includeGroupsClaims": true,
  
  
"allowCrossSubscription": true,
  
  
"allowUserLogin": true,
  
  
"allowClientCredentialLogin": true,
  
  
"accessTokenType": 0,
  
  
"securityProfile": 0,
  
  
"subjectType": 0,
  
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"resourceFilterEnabled": true,
  
"scopeFilterEnabled": true,
  
"clientUri": "string",
  
"logoUri": "string",
  
"backchannelLogoutUri": "string",
  
"backchannelLogoutSessionRequired": true,
  
"frontchannelLogoutUri": "string",
  
"frontchannelLogoutSessionRequired": true,
  
"enabled": true,
  
"isPublic": true,
  
"isRestricted": true,
  
"includeGroupsClaims": true,
  
"allowCrossSubscription": true,
  
"allowUserLogin": true,
  
"allowClientCredentialLogin": true,
  
"accessTokenType": 0,
  
"securityProfile": 0,
  
"subjectType": 0,
  
"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"
}

GetClientAppFederatedConfigurations

GET
/api/management/v2/ClientAppFederatedConfiguration

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"issuer": "string",
  
  
"subject": "string",
  
  
"clientAppId": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateClientAppFederatedConfiguration

POST
/api/management/v2/ClientAppFederatedConfiguration

Request Body

JSON
{
  
"id": "string",
  
"issuer": "string",
  
"subject": "string",
  
"clientAppId": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"issuer": "string",
  
"subject": "string",
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

UpdateClientAppFederatedConfigurationBatch

PUT
/api/management/v2/ClientAppFederatedConfiguration/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"issuer": "string",
  
  
"subject": "string",
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateClientAppFederatedConfigurationBatch

POST
/api/management/v2/ClientAppFederatedConfiguration/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"issuer": "string",
  
  
"subject": "string",
  
  
"clientAppId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteClientAppFederatedConfigurationBatch

DELETE
/api/management/v2/ClientAppFederatedConfiguration/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetClientAppFederatedConfiguration

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"issuer": "string",
  
"subject": "string",
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

UpdateClientAppFederatedConfiguration

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

Request Body

JSON
{
  
"id": "string",
  
"issuer": "string",
  
"subject": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"issuer": null,
  
"subject": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"issuer": "string",
  
"subject": "string",
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

GetClientAppFederatedConfigurationsByClientAppId

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

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"issuer": "string",
  
  
"subject": "string",
  
  
"clientAppId": "string",
  
  
"concurrencyToken": "string"
  
}
]

GetByClientAppId

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

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"sourceType": 0,
  
  
"usage": 0,
  
  
"status": 0,
  
  
"jwksUri": "string",
  
  
"jwksJson": "string",
  
  
"validFrom": "string",
  
  
"validTo": "string",
  
  
"lastValidatedOn": "string",
  
  
"lastValidationError": "string",
  
  
"clientAppId": "string",
  
  
"concurrencyToken": "string"
  
}
]

GetClientAppKeySets

GET
/api/management/v2/ClientAppKeySet

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"sourceType": 0,
  
  
"usage": 0,
  
  
"status": 0,
  
  
"jwksUri": "string",
  
  
"jwksJson": "string",
  
  
"validFrom": "string",
  
  
"validTo": "string",
  
  
"lastValidatedOn": "string",
  
  
"lastValidationError": "string",
  
  
"clientAppId": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateClientAppKeySet

POST
/api/management/v2/ClientAppKeySet

Request Body

JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"sourceType": 0,
  
"usage": 0,
  
"status": 0,
  
"jwksUri": "string",
  
"jwksJson": "string",
  
"protectedJwksJson": "string",
  
"validFrom": "string",
  
"validTo": "string",
  
"clientAppId": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"sourceType": 0,
  
"usage": 0,
  
"status": 0,
  
"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

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"sourceType": 0,
  
"usage": 0,
  
"status": 0,
  
"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

JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"sourceType": 0,
  
"usage": 0,
  
"status": 0,
  
"jwksUri": "string",
  
"jwksJson": "string",
  
"protectedJwksJson": "string",
  
"validFrom": "string",
  
"validTo": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"sourceType": 0,
  
"usage": 0,
  
"status": 0,
  
"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

JSON
{
  
"name": null,
  
"description": null,
  
"sourceType": null,
  
"usage": null,
  
"status": null,
  
"jwksUri": null,
  
"jwksJson": null,
  
"protectedJwksJson": null,
  
"validFrom": null,
  
"validTo": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"sourceType": 0,
  
"usage": 0,
  
"status": 0,
  
"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

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"sourceType": 0,
  
  
"usage": 0,
  
  
"status": 0,
  
  
"jwksUri": "string",
  
  
"jwksJson": "string",
  
  
"protectedJwksJson": "string",
  
  
"validFrom": "string",
  
  
"validTo": "string",
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateClientAppKeySets

POST
/api/management/v2/ClientAppKeySet/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"sourceType": 0,
  
  
"usage": 0,
  
  
"status": 0,
  
  
"jwksUri": "string",
  
  
"jwksJson": "string",
  
  
"protectedJwksJson": "string",
  
  
"validFrom": "string",
  
  
"validTo": "string",
  
  
"clientAppId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteClientAppKeySets

DELETE
/api/management/v2/ClientAppKeySet/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetClientAppMetadataByClientAppId

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

Responses

OK

application/json
JSON
[
  
{
  
  
"clientAppId": "string",
  
  
"key": "string",
  
  
"value": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateClientAppMetadata

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

Request Body

JSON
{
  
"clientAppId": "string",
  
"key": "string",
  
"value": "string"
}

Responses

OK

application/json
JSON
{
  
"clientAppId": "string",
  
"key": "string",
  
"value": "string",
  
"concurrencyToken": "string"
}

GetClientAppMetadata

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

Responses

OK

application/json
JSON
{
  
"clientAppId": "string",
  
"key": "string",
  
"value": "string",
  
"concurrencyToken": "string"
}

UpdateClientAppMetadata

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

Request Body

JSON
{
  
"value": "string",
  
"concurrencyToken": "string"
}

Responses

OK

application/json
JSON
{
  
"clientAppId": "string",
  
"key": "string",
  
"value": "string",
  
"concurrencyToken": "string"
}

DeleteClientAppMetadata

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

Responses

Bad Request

application/json
JSON
{
  
"type": "string",
  
"title": "string",
  
"status": null,
  
"detail": "string",
  
"instance": "string"
}

PatchClientAppMetadata

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

Request Body

JSON
{
  
"value": "string",
  
"concurrencyToken": "string"
}

Responses

OK

application/json
JSON
{
  
"clientAppId": "string",
  
"key": "string",
  
"value": "string",
  
"concurrencyToken": "string"
}

GetClientAppRedirectUris

GET
/api/management/v2/ClientAppRedirectUri

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"uri": "string",
  
  
"redirectType": 0,
  
  
"clientAppId": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateClientAppRedirectUri

POST
/api/management/v2/ClientAppRedirectUri

Request Body

JSON
{
  
"id": "string",
  
"uri": "string",
  
"redirectType": 0,
  
"clientAppId": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"uri": "string",
  
"redirectType": 0,
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

UpdateClientAppRedirectUriBatch

PUT
/api/management/v2/ClientAppRedirectUri/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"uri": "string",
  
  
"redirectType": 0,
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateClientAppRedirectUriBatch

POST
/api/management/v2/ClientAppRedirectUri/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"uri": "string",
  
  
"redirectType": 0,
  
  
"clientAppId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteClientAppRedirectUriBatch

DELETE
/api/management/v2/ClientAppRedirectUri/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetClientAppRedirectUri

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"uri": "string",
  
"redirectType": 0,
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

UpdateClientAppRedirectUri

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

Request Body

JSON
{
  
"id": "string",
  
"uri": "string",
  
"redirectType": 0,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"uri": "string",
  
"redirectType": 0,
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

DeleteClientAppRedirectUri

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

Responses

No Content


PatchClientAppRedirectUri

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

Request Body

JSON
{
  
"uri": null,
  
"redirectType": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"uri": "string",
  
"redirectType": 0,
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

GetClientAppRedirectUrisByClientAppId

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

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"uri": "string",
  
  
"redirectType": 0,
  
  
"clientAppId": "string",
  
  
"concurrencyToken": "string"
  
}
]

GetClientAppRequestUriByClientAppId

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

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"uri": "string",
  
  
"clientAppId": "string",
  
  
"concurrencyToken": "string"
  
}
]

GetClientAppRequestUris

GET
/api/management/v2/ClientAppRequestUri

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"uri": "string",
  
  
"clientAppId": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateClientAppRequestUri

POST
/api/management/v2/ClientAppRequestUri

Request Body

JSON
{
  
"id": "string",
  
"uri": "string",
  
"clientAppId": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"uri": "string",
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

GetClientAppRequestUri

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"uri": "string",
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

UpdateClientAppRequestUri

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

Request Body

JSON
{
  
"id": "string",
  
"uri": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"uri": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"uri": "string",
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

UpdateClientAppRequestUris

PUT
/api/management/v2/ClientAppRequestUri/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"uri": "string",
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateClientAppRequestUris

POST
/api/management/v2/ClientAppRequestUri/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"uri": "string",
  
  
"clientAppId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteClientAppRequestUris

DELETE
/api/management/v2/ClientAppRequestUri/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetClientAppResources

GET
/api/management/v2/ClientAppResource

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"key": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"clientAppId": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateClientAppResource

POST
/api/management/v2/ClientAppResource

Request Body

JSON
{
  
"id": "string",
  
"key": "string",
  
"name": "string",
  
"description": "string",
  
"clientAppId": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"key": "string",
  
"name": "string",
  
"description": "string",
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

UpdateClientAppResourceBatch

PUT
/api/management/v2/ClientAppResource/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"key": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateClientAppResourceBatch

POST
/api/management/v2/ClientAppResource/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"key": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"clientAppId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteClientAppResourceBatch

DELETE
/api/management/v2/ClientAppResource/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetClientAppResource

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"key": "string",
  
"name": "string",
  
"description": "string",
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

UpdateClientAppResource

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

Request Body

JSON
{
  
"id": "string",
  
"key": "string",
  
"name": "string",
  
"description": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"key": null,
  
"name": null,
  
"description": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"key": "string",
  
"name": "string",
  
"description": "string",
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

GetClientAppResourcesByClientAppId

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

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"key": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"clientAppId": "string",
  
  
"concurrencyToken": "string"
  
}
]

GetClientAppRoles

GET
/api/management/v2/ClientAppRole

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"roleType": 0,
  
  
"applyToTenantId": "string",
  
  
"applyToIdpInstanceId": "string",
  
  
"clientAppId": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateClientAppRole

POST
/api/management/v2/ClientAppRole

Request Body

JSON
{
  
"id": "string",
  
"roleType": 0,
  
"applyToTenantId": "string",
  
"applyToIdpInstanceId": "string",
  
"clientAppId": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"roleType": 0,
  
"applyToTenantId": "string",
  
"applyToIdpInstanceId": "string",
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

UpdateClientAppRoleBatch

PUT
/api/management/v2/ClientAppRole/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"roleType": 0,
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateClientAppRoleBatch

POST
/api/management/v2/ClientAppRole/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"roleType": 0,
  
  
"applyToTenantId": "string",
  
  
"applyToIdpInstanceId": "string",
  
  
"clientAppId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteClientAppRoleBatch

DELETE
/api/management/v2/ClientAppRole/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetClientAppRole

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"roleType": 0,
  
"applyToTenantId": "string",
  
"applyToIdpInstanceId": "string",
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

UpdateClientAppRole

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

Request Body

JSON
{
  
"id": "string",
  
"roleType": 0,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"roleType": 0,
  
"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

JSON
{
  
"roleType": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"roleType": 0,
  
"applyToTenantId": "string",
  
"applyToIdpInstanceId": "string",
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

GetClientAppRolesByClientAppId

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

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"roleType": 0,
  
  
"applyToTenantId": "string",
  
  
"applyToIdpInstanceId": "string",
  
  
"clientAppId": "string",
  
  
"concurrencyToken": "string"
  
}
]

GetClientAppScopes

GET
/api/management/v2/ClientAppScope

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"key": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"clientAppId": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateClientAppScope

POST
/api/management/v2/ClientAppScope

Request Body

JSON
{
  
"id": "string",
  
"key": "string",
  
"name": "string",
  
"description": "string",
  
"clientAppId": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"key": "string",
  
"name": "string",
  
"description": "string",
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

UpdateClientAppScopeBatch

PUT
/api/management/v2/ClientAppScope/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"key": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateClientAppScopeBatch

POST
/api/management/v2/ClientAppScope/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"key": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"clientAppId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteClientAppScopeBatch

DELETE
/api/management/v2/ClientAppScope/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetClientAppScope

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"key": "string",
  
"name": "string",
  
"description": "string",
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

UpdateClientAppScope

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

Request Body

JSON
{
  
"id": "string",
  
"key": "string",
  
"name": "string",
  
"description": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"key": null,
  
"name": null,
  
"description": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"key": "string",
  
"name": "string",
  
"description": "string",
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

GetClientAppScopesByClientAppId

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

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"key": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"clientAppId": "string",
  
  
"concurrencyToken": "string"
  
}
]

GetClientAppSecrets

GET
/api/management/v2/ClientAppSecret

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"secret": "string",
  
  
"expiry": "string",
  
  
"clientAppId": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateClientAppSecret

POST
/api/management/v2/ClientAppSecret

Request Body

JSON
{
  
"id": "string",
  
"name": "string",
  
"secret": "string",
  
"expiry": "string",
  
"clientAppId": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"secret": "string",
  
"expiry": "string",
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

UpdateClientAppSecretBatch

PUT
/api/management/v2/ClientAppSecret/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"expiry": "string",
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateClientAppSecretBatch

POST
/api/management/v2/ClientAppSecret/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"secret": "string",
  
  
"expiry": "string",
  
  
"clientAppId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteClientAppSecretBatch

DELETE
/api/management/v2/ClientAppSecret/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetClientAppSecret

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"secret": "string",
  
"expiry": "string",
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

UpdateClientAppSecret

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

Request Body

JSON
{
  
"id": "string",
  
"name": "string",
  
"expiry": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"name": null,
  
"expiry": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"secret": "string",
  
"expiry": "string",
  
"clientAppId": "string",
  
"concurrencyToken": "string"
}

GetClientAppSecretsByClientAppId

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

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"secret": "string",
  
  
"expiry": "string",
  
  
"clientAppId": "string",
  
  
"concurrencyToken": "string"
  
}
]

GetCustomAsset

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

Responses

OK

application/json
JSON
{
  
"location": "string",
  
"mimetype": "string",
  
"data": "string",
  
"size": 0,
  
"fileName": "string",
  
"concurrencyToken": "string"
}

UpdateCustomAsset

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

Request Body

JSON
{
  
"location": "string",
  
"mimetype": "string",
  
"data": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"mimetype": "string",
  
"data": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"location": "string",
  
"mimetype": "string",
  
"data": "string",
  
"size": 0,
  
"fileName": "string",
  
"concurrencyToken": "string"
}

GetCustomAssets

GET
/api/management/v2/CustomAsset

Responses

OK

application/json
JSON
[
  
{
  
  
"location": "string",
  
  
"mimetype": "string",
  
  
"data": "string",
  
  
"size": 0,
  
  
"fileName": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateCustomAsset

POST
/api/management/v2/CustomAsset

Request Body

JSON
{
  
"location": "string",
  
"mimetype": "string",
  
"data": "string"
}

Responses

Created

application/json
JSON
{
  
"location": "string",
  
"mimetype": "string",
  
"data": "string",
  
"size": 0,
  
"fileName": "string",
  
"concurrencyToken": "string"
}

UpdateCustomAssetBatch

PUT
/api/management/v2/CustomAsset/batch

Request Body

JSON
[
  
{
  
  
"location": "string",
  
  
"mimetype": "string",
  
  
"data": "string",
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateCustomAssetBatch

POST
/api/management/v2/CustomAsset/batch

Request Body

JSON
[
  
{
  
  
"location": "string",
  
  
"mimetype": "string",
  
  
"data": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteCustomAssetBatch

DELETE
/api/management/v2/CustomAsset/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


CreateCustomAssetByExpander

POST
/api/management/v2/CustomAsset/create

Request Body

JSON
{
  
"mimetype": "string",
  
"assetFileName": "string",
  
"data": "string",
  
"applyToType": 0,
  
"tenantId": "string",
  
"clientAppId": "string",
  
"subscriptionId": "string",
  
"location": "string"
}

Responses

Created

application/json
JSON
{
  
"location": "string",
  
"mimetype": "string",
  
"data": "string",
  
"size": 0,
  
"fileName": "string",
  
"concurrencyToken": "string"
}

GetSupportedMimetypes

GET
/api/management/v2/CustomAsset/mimetypes

Responses

OK

application/json
JSON
[
]

GetCustomers

GET
/api/management/v2/Customer

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"address": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateCustomer

POST
/api/management/v2/Customer

Request Body

JSON
{
  
"id": "string",
  
"name": "string",
  
"address": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"address": "string",
  
"concurrencyToken": "string"
}

UpdateCustomerBatch

PUT
/api/management/v2/Customer/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"address": "string",
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateCustomerBatch

POST
/api/management/v2/Customer/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"address": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteCustomerBatch

DELETE
/api/management/v2/Customer/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetCustomer

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"address": "string",
  
"concurrencyToken": "string"
}

UpdateCustomer

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

Request Body

JSON
{
  
"id": "string",
  
"name": "string",
  
"address": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"name": "string",
  
"address": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"address": "string",
  
"concurrencyToken": "string"
}

GetCustomView

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

Responses

OK

application/json
JSON
{
  
"location": "string",
  
"content": "string",
  
"concurrencyToken": "string"
}

UpdateCustomView

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

Request Body

JSON
{
  
"location": "string",
  
"content": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"content": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"location": "string",
  
"content": "string",
  
"concurrencyToken": "string"
}

GetCustomViews

GET
/api/management/v2/CustomView

Responses

OK

application/json
JSON
[
  
{
  
  
"location": "string",
  
  
"content": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateCustomView

POST
/api/management/v2/CustomView

Request Body

JSON
{
  
"location": "string",
  
"content": "string"
}

Responses

Created

application/json
JSON
{
  
"location": "string",
  
"content": "string",
  
"concurrencyToken": "string"
}

UpdateCustomViewBatch

PUT
/api/management/v2/CustomView/batch

Request Body

JSON
[
  
{
  
  
"location": "string",
  
  
"content": "string",
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateCustomViewBatch

POST
/api/management/v2/CustomView/batch

Request Body

JSON
[
  
{
  
  
"location": "string",
  
  
"content": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteBatch

DELETE
/api/management/v2/CustomView/batch

Request Body

JSON
[
]

Responses

No Content


CreateCustomViewFromTemplate

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

Request Body

JSON
{
  
"viewName": "string",
  
"applyToType": 0,
  
"tenantId": "string",
  
"clientAppId": "string",
  
"subscriptionId": "string",
  
"location": "string"
}

Responses

Created

application/json
JSON
{
  
"location": "string",
  
"content": "string",
  
"concurrencyToken": "string"
}

GetAllTemplateViews

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

Responses

OK

application/json
JSON
[
]

GetTemplateViewContent

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

Responses

OK

application/json
JSON
"string"

GetForUser

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

Responses

OK

JSON
{
  
"principalId": "string",
  
"principalType": "string",
  
"scope": "string",
  
"assignments": [
  
  
{...}
  
],
  
"permissions": [
  
  
{...}
  
]
}

GetForGroup

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

Responses

OK

JSON
{
  
"principalId": "string",
  
"principalType": "string",
  
"scope": "string",
  
"assignments": [
  
  
{...}
  
],
  
"permissions": [
  
  
{...}
  
]
}

GetForClientApp

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

Responses

OK

JSON
{
  
"principalId": "string",
  
"principalType": "string",
  
"scope": "string",
  
"assignments": [
  
  
{...}
  
],
  
"permissions": [
  
  
{...}
  
]
}

IdpInstance


GetIdpInstances

GET
/api/management/v2/IdpInstance

Responses

OK

application/json
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

JSON
{
  
"id": "string",
  
"name": "string",
  
"position": 0,
  
"isActive": true,
  
"treatMfaFactorClaimsAsConfirmed": true,
  
"autoCreateProAuthUser": true,
  
"isHidden": true,
  
"idpTypeId": "string",
  
"subscriptionId": "string"
}

Responses

Created

application/json
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

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"position": 0,
  
  
"isActive": true,
  
  
"treatMfaFactorClaimsAsConfirmed": true,
  
  
"autoCreateProAuthUser": true,
  
  
"isHidden": true,
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateIdpInstanceBatch

POST
/api/management/v2/IdpInstance/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"position": 0,
  
  
"isActive": true,
  
  
"treatMfaFactorClaimsAsConfirmed": true,
  
  
"autoCreateProAuthUser": true,
  
  
"isHidden": true,
  
  
"idpTypeId": "string",
  
  
"subscriptionId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteIdpInstanceBatch

DELETE
/api/management/v2/IdpInstance/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetIdpInstance

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

Responses

OK

application/json
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

JSON
{
  
"id": "string",
  
"name": "string",
  
"position": 0,
  
"isActive": true,
  
"treatMfaFactorClaimsAsConfirmed": true,
  
"autoCreateProAuthUser": true,
  
"isHidden": true,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"name": null,
  
"position": null,
  
"isActive": null,
  
"treatMfaFactorClaimsAsConfirmed": null,
  
"autoCreateProAuthUser": null,
  
"isHidden": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

application/json
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

application/json
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

application/json
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

application/json
JSON
{
  
"type": "string",
  
"title": "string",
  
"status": null,
  
"detail": "string",
  
"instance": "string"
}

GetHealthStatus

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

Responses

OK

application/json
JSON
{
  
"instanceId": null,
  
"hasConfigurationError": true,
  
"isOperational": true
}

SetIdpInstanceTenants

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

Request Body

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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"
}

GetIdpInstanceMetadataByIdpInstanceId

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

Responses

OK

application/json
JSON
[
  
{
  
  
"idpInstanceId": null,
  
  
"key": "string",
  
  
"value": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateIdpInstanceMetadata

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

Request Body

JSON
{
  
"idpInstanceId": "string",
  
"key": "string",
  
"value": "string"
}

Responses

OK

application/json
JSON
{
  
"idpInstanceId": null,
  
"key": "string",
  
"value": "string",
  
"concurrencyToken": "string"
}

GetIdpInstanceMetadata

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

Responses

OK

application/json
JSON
{
  
"idpInstanceId": null,
  
"key": "string",
  
"value": "string",
  
"concurrencyToken": "string"
}

UpdateIdpInstanceMetadata

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

Request Body

JSON
{
  
"value": "string",
  
"concurrencyToken": "string"
}

Responses

OK

application/json
JSON
{
  
"idpInstanceId": null,
  
"key": "string",
  
"value": "string",
  
"concurrencyToken": "string"
}

DeleteIdpInstanceMetadata

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

Responses

Bad Request

application/json
JSON
{
  
"type": "string",
  
"title": "string",
  
"status": null,
  
"detail": "string",
  
"instance": "string"
}

PatchIdpInstanceMetadata

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

Request Body

JSON
{
  
"value": "string",
  
"concurrencyToken": "string"
}

Responses

OK

application/json
JSON
{
  
"idpInstanceId": null,
  
"key": "string",
  
"value": "string",
  
"concurrencyToken": "string"
}

GetIdpType

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

Responses

OK

application/json
JSON
{
  
"id": null,
  
"name": "string",
  
"providerType": 0,
  
"factoryType": "string",
  
"isActive": true,
  
"concurrencyToken": "string"
}

UpdateIdpType

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

Request Body

JSON
{
  
"id": "string",
  
"name": "string",
  
"providerType": 0,
  
"factoryType": "string",
  
"isActive": true,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": null,
  
"name": "string",
  
"providerType": 0,
  
"factoryType": "string",
  
"isActive": true,
  
"concurrencyToken": "string"
}

PatchIdpType

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

Request Body

JSON
{
  
"name": "string",
  
"providerType": 0,
  
"factoryType": "string",
  
"isActive": true,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": null,
  
"name": "string",
  
"providerType": 0,
  
"factoryType": "string",
  
"isActive": true,
  
"concurrencyToken": "string"
}

UpdateIdpTypeBatch

PUT
/api/management/v2/IdpType/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"providerType": 0,
  
  
"factoryType": "string",
  
  
"isActive": true,
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
  
{
  
  
"id": null,
  
  
"name": "string",
  
  
"providerType": 0,
  
  
"factoryType": "string",
  
  
"isActive": true,
  
  
"concurrencyToken": "string"
  
}
]

GetIdpTypeByName

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

Responses

OK

application/json
JSON
{
  
"id": null,
  
"name": "string",
  
"providerType": 0,
  
"factoryType": "string",
  
"isActive": true,
  
"concurrencyToken": "string"
}

GetIdpTypes

GET
/api/management/v2/IdpType

Responses

OK

application/json
JSON
[
]

GetIpAddressRanges

GET
/api/management/v2/IpAddressRange

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"lower": "string",
  
  
"upper": "string",
  
  
"tenantId": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateIpAddressRange

POST
/api/management/v2/IpAddressRange

Request Body

JSON
{
  
"id": "string",
  
"lower": "string",
  
"upper": "string",
  
"tenantId": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"lower": "string",
  
"upper": "string",
  
"tenantId": "string",
  
"concurrencyToken": "string"
}

UpdateIpAddressRangeBatch

PUT
/api/management/v2/IpAddressRange/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"lower": "string",
  
  
"upper": "string",
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateIpAddressRangeBatch

POST
/api/management/v2/IpAddressRange/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"lower": "string",
  
  
"upper": "string",
  
  
"tenantId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteIpAddressRangeBatch

DELETE
/api/management/v2/IpAddressRange/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetIpAddressRange

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"lower": "string",
  
"upper": "string",
  
"tenantId": "string",
  
"concurrencyToken": "string"
}

UpdateIpAddressRange

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

Request Body

JSON
{
  
"id": "string",
  
"lower": "string",
  
"upper": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"lower": null,
  
"upper": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"lower": "string",
  
"upper": "string",
  
"tenantId": "string",
  
"concurrencyToken": "string"
}

GetIpAddressRangesForTenantId

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

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"lower": "string",
  
  
"upper": "string",
  
  
"tenantId": "string",
  
  
"concurrencyToken": "string"
  
}
]

MfaInstance


GetMfaInstances

GET
/api/management/v2/MfaInstance

Responses

OK

application/json
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

JSON
{
  
"id": "string",
  
"name": "string",
  
"executionOrder": 0,
  
"isActive": true,
  
"mfaTypeId": "string",
  
"subscriptionId": "string"
}

Responses

Created

application/json
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

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"executionOrder": 0,
  
  
"isActive": true,
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateMfaInstanceBatch

POST
/api/management/v2/MfaInstance/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"executionOrder": 0,
  
  
"isActive": true,
  
  
"mfaTypeId": "string",
  
  
"subscriptionId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteMfaInstanceBatch

DELETE
/api/management/v2/MfaInstance/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetMfaInstance

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

Responses

OK

application/json
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

JSON
{
  
"id": "string",
  
"name": "string",
  
"executionOrder": 0,
  
"isActive": true,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"name": null,
  
"executionOrder": null,
  
"isActive": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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"
}

GetMfaInstanceMetadata

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

Responses

OK

application/json
JSON
{
  
"mfaInstanceId": "string",
  
"key": "string",
  
"value": "string",
  
"concurrencyToken": "string"
}

UpdateMfaInstanceMetadata

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

Request Body

JSON
{
  
"value": "string",
  
"concurrencyToken": "string"
}

Responses

OK

application/json
JSON
{
  
"mfaInstanceId": "string",
  
"key": "string",
  
"value": "string",
  
"concurrencyToken": "string"
}

DeleteMfaInstanceMetadata

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

Responses

Bad Request

application/json
JSON
{
  
"type": "string",
  
"title": "string",
  
"status": null,
  
"detail": "string",
  
"instance": "string"
}

PatchMfaInstanceMetadata

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

Request Body

JSON
{
  
"value": "string",
  
"concurrencyToken": "string"
}

Responses

OK

application/json
JSON
{
  
"mfaInstanceId": "string",
  
"key": "string",
  
"value": "string",
  
"concurrencyToken": "string"
}

GetMfaInstanceMetadataByMfaInstanceId

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

Responses

OK

application/json
JSON
[
  
{
  
  
"mfaInstanceId": "string",
  
  
"key": "string",
  
  
"value": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateMfaInstanceMetadata

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

Request Body

JSON
{
  
"mfaInstanceId": "string",
  
"key": "string",
  
"value": "string"
}

Responses

Created

application/json
JSON
{
  
"mfaInstanceId": "string",
  
"key": "string",
  
"value": "string",
  
"concurrencyToken": "string"
}

GetMfaType

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

Responses

OK

application/json
JSON
{
  
"id": null,
  
"name": "string",
  
"factoryType": "string",
  
"isEnabled": true,
  
"concurrencyToken": "string"
}

UpdateMfaType

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

Request Body

JSON
{
  
"id": "string",
  
"name": "string",
  
"factoryType": "string",
  
"isEnabled": true,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": null,
  
"name": "string",
  
"factoryType": "string",
  
"isEnabled": true,
  
"concurrencyToken": "string"
}

PatchMfaType

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

Request Body

JSON
{
  
"name": "string",
  
"factoryType": "string",
  
"isEnabled": true,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": null,
  
"name": "string",
  
"factoryType": "string",
  
"isEnabled": true,
  
"concurrencyToken": "string"
}

UpdateMfaTypeBatch

PUT
/api/management/v2/MfaType/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"factoryType": "string",
  
  
"isEnabled": true,
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
  
{
  
  
"id": null,
  
  
"name": "string",
  
  
"factoryType": "string",
  
  
"isEnabled": true,
  
  
"concurrencyToken": "string"
  
}
]

GetMfaTypeByName

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

Responses

OK

application/json
JSON
{
  
"id": null,
  
"name": "string",
  
"factoryType": "string",
  
"isEnabled": true,
  
"concurrencyToken": "string"
}

GetMfaTypes

GET
/api/management/v2/MfaType

Responses

OK

application/json
JSON
[
]

GetOptions

GET
/api/management/v2/Option

Responses

OK

application/json
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

JSON
{
  
"id": "string",
  
"name": "string",
  
"value": "string",
  
"applyToIdpInstanceId": "string",
  
"applyToMfaInstanceId": "string",
  
"applyToTenantId": "string"
}

Responses

Created

application/json
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

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"value": "string",
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateBatch

POST
/api/management/v2/Option/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"value": "string",
  
  
"applyToIdpInstanceId": "string",
  
  
"applyToMfaInstanceId": "string",
  
  
"applyToTenantId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteBatch

DELETE
/api/management/v2/Option/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetOption

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

Responses

OK

application/json
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

JSON
{
  
"id": "string",
  
"name": "string",
  
"value": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"name": null,
  
"value": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

application/json
JSON
"string"

GetOptionByType

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

Responses

OK

application/json
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

application/json
JSON
[
]

GetOptionMetadataByName

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"category": 0,
  
"isMandatory": true,
  
"defaultValue": "string",
  
"optionType": 0,
  
"dataType": 0,
  
"editorType": 0,
  
"optionTargetType": 0,
  
"applyToIdpTypeId": "string",
  
"applyToMfaTypeId": "string",
  
"concurrencyToken": "string"
}

GetOptionsMetadatas

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

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"category": 0,
  
  
"isMandatory": true,
  
  
"defaultValue": "string",
  
  
"optionType": 0,
  
  
"dataType": 0,
  
  
"editorType": 0,
  
  
"optionTargetType": 0,
  
  
"applyToIdpTypeId": "string",
  
  
"applyToMfaTypeId": "string",
  
  
"concurrencyToken": "string"
  
}
]

GetOptionMetadata

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"category": 0,
  
"isMandatory": true,
  
"defaultValue": "string",
  
"optionType": 0,
  
"dataType": 0,
  
"editorType": 0,
  
"optionTargetType": 0,
  
"applyToIdpTypeId": "string",
  
"applyToMfaTypeId": "string",
  
"concurrencyToken": "string"
}

GetOptionMetadatas

GET
/api/management/v2/OptionMetadata

Responses

OK

application/json
JSON
[
]

ProAuthGroup


GetProAuthGroups

GET
/api/management/v2/ProAuthGroup

Responses

OK

application/json
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

JSON
{
  
"id": "string",
  
"name": "string",
  
"scimExternalId": "string",
  
"idpInstanceId": "string",
  
"subscriptionId": "string",
  
"applyToTenantId": "string"
}

Responses

Created

application/json
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

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"scimExternalId": "string",
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateProAuthGroupBatch

POST
/api/management/v2/ProAuthGroup/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"scimExternalId": "string",
  
  
"idpInstanceId": "string",
  
  
"subscriptionId": "string",
  
  
"applyToTenantId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteProAuthGroupBatch

DELETE
/api/management/v2/ProAuthGroup/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetProAuthGroup

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

Responses

OK

application/json
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

JSON
{
  
"id": "string",
  
"name": "string",
  
"scimExternalId": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"name": null,
  
"scimExternalId": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

application/json
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

application/json
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"
}

GetProAuthGroupMetadataByProAuthGroupId

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

Responses

OK

application/json
JSON
[
  
{
  
  
"proAuthGroupId": null,
  
  
"key": "string",
  
  
"value": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateProAuthGroupMetadata

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

Request Body

JSON
{
  
"proAuthGroupId": "string",
  
"key": "string",
  
"value": "string"
}

Responses

OK

application/json
JSON
{
  
"proAuthGroupId": null,
  
"key": "string",
  
"value": "string",
  
"concurrencyToken": "string"
}

GetProAuthGroupMetadata

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

Responses

OK

application/json
JSON
{
  
"proAuthGroupId": null,
  
"key": "string",
  
"value": "string",
  
"concurrencyToken": "string"
}

UpdateProAuthGroupMetadata

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

Request Body

JSON
{
  
"value": "string",
  
"concurrencyToken": "string"
}

Responses

OK

application/json
JSON
{
  
"proAuthGroupId": null,
  
"key": "string",
  
"value": "string",
  
"concurrencyToken": "string"
}

DeleteProAuthGroupMetadata

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

Responses

Bad Request

application/json
JSON
{
  
"type": "string",
  
"title": "string",
  
"status": null,
  
"detail": "string",
  
"instance": "string"
}

PatchProAuthGroupMetadata

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

Request Body

JSON
{
  
"value": "string",
  
"concurrencyToken": "string"
}

Responses

OK

application/json
JSON
{
  
"proAuthGroupId": null,
  
"key": "string",
  
"value": "string",
  
"concurrencyToken": "string"
}

GetProAuthGroupRoles

GET
/api/management/v2/ProAuthGroupRole

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"roleType": 0,
  
  
"applyToTenantId": "string",
  
  
"applyToIdpInstanceId": "string",
  
  
"proAuthGroupId": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateProAuthGroupRole

POST
/api/management/v2/ProAuthGroupRole

Request Body

JSON
{
  
"id": "string",
  
"roleType": 0,
  
"applyToTenantId": "string",
  
"applyToIdpInstanceId": "string",
  
"proAuthGroupId": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"roleType": 0,
  
"applyToTenantId": "string",
  
"applyToIdpInstanceId": "string",
  
"proAuthGroupId": "string",
  
"concurrencyToken": "string"
}

UpdateProAuthGroupRoleBatch

PUT
/api/management/v2/ProAuthGroupRole/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"roleType": 0,
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateProAuthGroupRoleBatch

POST
/api/management/v2/ProAuthGroupRole/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"roleType": 0,
  
  
"applyToTenantId": "string",
  
  
"applyToIdpInstanceId": "string",
  
  
"proAuthGroupId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteProAuthGroupRoleBatch

DELETE
/api/management/v2/ProAuthGroupRole/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetProAuthGroupRole

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"roleType": 0,
  
"applyToTenantId": "string",
  
"applyToIdpInstanceId": "string",
  
"proAuthGroupId": "string",
  
"concurrencyToken": "string"
}

UpdateProAuthGroupRole

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

Request Body

JSON
{
  
"id": "string",
  
"roleType": 0,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"roleType": 0,
  
"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

JSON
{
  
"roleType": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"roleType": 0,
  
"applyToTenantId": "string",
  
"applyToIdpInstanceId": "string",
  
"proAuthGroupId": "string",
  
"concurrencyToken": "string"
}

GetProAuthGroupRolesByGroup

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

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"roleType": 0,
  
  
"applyToTenantId": "string",
  
  
"applyToIdpInstanceId": "string",
  
  
"proAuthGroupId": "string",
  
  
"concurrencyToken": "string"
  
}
]

GetProAuthPermissions

GET
/api/management/v2/ProAuthPermission

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"resource": "string",
  
  
"action": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateProAuthPermission

POST
/api/management/v2/ProAuthPermission

Request Body

JSON
{
  
"id": "string",
  
"resource": "string",
  
"action": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"resource": "string",
  
"action": "string",
  
"concurrencyToken": "string"
}

GetProAuthPermission

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"resource": "string",
  
"action": "string",
  
"concurrencyToken": "string"
}

UpdateProAuthPermission

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

Request Body

JSON
{
  
"id": "string",
  
"resource": "string",
  
"action": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"id": "string",
  
"resource": "string",
  
"action": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"resource": "string",
  
"action": "string",
  
"concurrencyToken": "string"
}

UpdateProAuthPermissions

PUT
/api/management/v2/ProAuthPermission/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"resource": "string",
  
  
"action": "string",
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateProAuthPermissions

POST
/api/management/v2/ProAuthPermission/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"resource": "string",
  
  
"action": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteProAuthPermissions

DELETE
/api/management/v2/ProAuthPermission/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetProAuthRoleAssignments

GET
/api/management/v2/ProAuthRoleAssignment

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"principalId": "string",
  
  
"principalType": "string",
  
  
"roleId": "string",
  
  
"roleName": "string",
  
  
"scope": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateProAuthRoleAssignment

POST
/api/management/v2/ProAuthRoleAssignment

Request Body

JSON
{
  
"id": "string",
  
"principalId": "string",
  
"principalType": "string",
  
"roleId": "string",
  
"roleName": "string",
  
"scope": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"principalId": "string",
  
"principalType": "string",
  
"roleId": "string",
  
"roleName": "string",
  
"scope": "string",
  
"concurrencyToken": "string"
}

GetProAuthRoleAssignment

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

Responses

OK

application/json
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

JSON
[
  
{
  
  
"id": "string",
  
  
"principalId": "string",
  
  
"principalType": "string",
  
  
"roleId": "string",
  
  
"roleName": "string",
  
  
"scope": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteProAuthRoleAssignments

DELETE
/api/management/v2/ProAuthRoleAssignment/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetProAuthRoles

GET
/api/management/v2/ProAuthRole

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"isSystemDefined": true,
  
  
"concurrencyToken": "string"
  
}
]

CreateProAuthRole

POST
/api/management/v2/ProAuthRole

Request Body

JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"isSystemDefined": true,
  
"concurrencyToken": "string"
}

GetProAuthRole

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"isSystemDefined": true,
  
"concurrencyToken": "string"
}

UpdateProAuthRole

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

Request Body

JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"description": "string",
  
"isSystemDefined": true,
  
"concurrencyToken": "string"
}

GetSystemRoles

GET
/api/management/v2/ProAuthRole/system

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"isSystemDefined": true,
  
  
"concurrencyToken": "string"
  
}
]

UpdateProAuthRoles

PUT
/api/management/v2/ProAuthRole/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateProAuthRoles

POST
/api/management/v2/ProAuthRole/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"description": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteProAuthRoles

DELETE
/api/management/v2/ProAuthRole/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


ProAuthUser


GetProAuthUsers

GET
/api/management/v2/ProAuthUser

Responses

OK

application/json
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

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"
}

Responses

Created

application/json
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

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",
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateProAuthUserBatch

POST
/api/management/v2/ProAuthUser/batch

Request Body

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"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteProAuthUserBatch

DELETE
/api/management/v2/ProAuthUser/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetProAuthUser

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

Responses

OK

application/json
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

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",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"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,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"emailAddress": "string",
  
"emailAddressConfirmed": true,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
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

application/json
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

application/json
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

application/json
JSON
{
  
"type": "string",
  
"title": "string",
  
"status": null,
  
"detail": "string",
  
"instance": "string"
}

DeleteAllProAuthUsersByIdp

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

Responses

Bad Request

application/json
JSON
{
  
"type": "string",
  
"title": "string",
  
"status": null,
  
"detail": "string",
  
"instance": "string"
}

DeleteAllProAuthUsersBySubscription

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

Responses

Bad Request

application/json
JSON
{
  
"type": "string",
  
"title": "string",
  
"status": null,
  
"detail": "string",
  
"instance": "string"
}

DeleteAllProAuthUsersWithoutAssignedIdpOfSubscription

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

Responses

Bad Request

application/json
JSON
{
  
"type": "string",
  
"title": "string",
  
"status": null,
  
"detail": "string",
  
"instance": "string"
}

GetProAuthUserByExternalUniqueUserId

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

Responses

OK

application/json
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

application/json
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

application/json
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

application/json
JSON
{
  
"type": "string",
  
"title": "string",
  
"status": null,
  
"detail": "string",
  
"instance": "string"
}

GetProAuthUserFederatedConfiguration

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"issuer": "string",
  
"subject": "string",
  
"proAuthUserId": "string",
  
"idpInstanceId": "string",
  
"isInternalFederation": true,
  
"isFederatedThroughIdpInstance": true,
  
"concurrencyToken": "string"
}

GetProAuthUserFederatedConfigurations

GET
/api/management/v2/ProAuthUserFederatedConfiguration

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"issuer": "string",
  
  
"subject": "string",
  
  
"proAuthUserId": "string",
  
  
"idpInstanceId": "string",
  
  
"isInternalFederation": true,
  
  
"isFederatedThroughIdpInstance": true,
  
  
"concurrencyToken": "string"
  
}
]

GetProAuthUserInvitations

GET
/api/management/v2/ProAuthUserInvitation

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"firstName": "string",
  
  
"lastName": "string",
  
  
"emailAddress": "string",
  
  
"isUserActive": true,
  
  
"subscriptionId": "string",
  
  
"tenantId": "string"
  
}
]

GetProAuthUserInvitation

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"firstName": "string",
  
"lastName": "string",
  
"emailAddress": "string",
  
"isUserActive": true,
  
"subscriptionId": "string",
  
"tenantId": "string"
}

CreateInvitation

POST
/api/management/v2/ProAuthUserInvitation/invite

Request Body

JSON
{
  
"firstName": "string",
  
"lastName": "string",
  
"emailAddress": "string",
  
"isUserActive": true,
  
"subscriptionId": "string",
  
"tenantId": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"firstName": "string",
  
"lastName": "string",
  
"emailAddress": "string",
  
"isUserActive": true,
  
"subscriptionId": "string",
  
"tenantId": "string"
}

SendInvitation

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

Responses

OK

application/json
JSON
true

ProAuthUserMfaFactor


GetProAuthUserMfaFactors

GET
/api/management/v2/ProAuthUserMfaFactor

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"mfaFactorType": 0,
  
  
"mfaFactorValue": "string",
  
  
"confirmed": true,
  
  
"confirmationCodeExpiration": "string",
  
  
"proAuthUserId": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateProAuthUserMfaFactor

POST
/api/management/v2/ProAuthUserMfaFactor

Request Body

JSON
{
  
"id": "string",
  
"mfaFactorType": 0,
  
"mfaFactorValue": "string",
  
"proAuthUserId": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"mfaFactorType": 0,
  
"mfaFactorValue": "string",
  
"confirmed": true,
  
"confirmationCodeExpiration": "string",
  
"proAuthUserId": "string",
  
"concurrencyToken": "string"
}

UpdateProAuthUserMfaFactorBatch

PUT
/api/management/v2/ProAuthUserMfaFactor/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"mfaFactorType": 0,
  
  
"mfaFactorValue": "string",
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateProAuthUserMfaFactorBatch

POST
/api/management/v2/ProAuthUserMfaFactor/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"mfaFactorType": 0,
  
  
"mfaFactorValue": "string",
  
  
"proAuthUserId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteProAuthUserMfaFactorBatch

DELETE
/api/management/v2/ProAuthUserMfaFactor/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetProAuthUserMfaFactor

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"mfaFactorType": 0,
  
"mfaFactorValue": "string",
  
"confirmed": true,
  
"confirmationCodeExpiration": "string",
  
"proAuthUserId": "string",
  
"concurrencyToken": "string"
}

UpdateProAuthUserMfaFactor

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

Request Body

JSON
{
  
"id": "string",
  
"mfaFactorType": 0,
  
"mfaFactorValue": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"mfaFactorType": 0,
  
"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

JSON
{
  
"mfaFactorType": null,
  
"mfaFactorValue": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"mfaFactorType": 0,
  
"mfaFactorValue": "string",
  
"confirmed": true,
  
"confirmationCodeExpiration": "string",
  
"proAuthUserId": "string",
  
"concurrencyToken": "string"
}

GetMfaFactorByType

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"mfaFactorType": 0,
  
"mfaFactorValue": "string",
  
"confirmed": true,
  
"confirmationCodeExpiration": "string",
  
"proAuthUserId": "string",
  
"concurrencyToken": "string"
}

GetMfaFactorsByProAuthUserId

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

Responses

OK

application/json
JSON
[
]

GetMfaRecoveryCodeSet

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

Responses

OK

application/json
JSON
[
]

CreateMfaRecoveryCodes

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

Responses

Created

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"recoveryCode": "string",
  
  
"recoveryGroup": "string",
  
  
"redeemed": true,
  
  
"redeemTimeStamp": "string",
  
  
"invalidated": true,
  
  
"invalidatedTimeStamp": "string",
  
  
"proAuthUserId": "string",
  
  
"concurrencyToken": "string"
  
}
]

GetProAuthUserProfiles

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

Responses

OK

application/json
JSON
[
  
{
  
  
"proAuthUserId": "string",
  
  
"key": "string",
  
  
"value": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateProAuthUserProfile

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

Request Body

JSON
{
  
"proAuthUserId": "string",
  
"key": "string",
  
"value": "string"
}

Responses

Accepted

application/json
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

application/json
JSON
{
  
"proAuthUserId": "string",
  
"key": "string",
  
"value": "string",
  
"concurrencyToken": "string"
}

UpdateProAuthUserProfile

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

Request Body

JSON
{
  
"value": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
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

application/json
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"
}

GetProAuthUserQuestionnaires

GET
/api/management/v2/ProAuthUserQuestionnaire

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"isActive": true,
  
  
"applyToType": 0,
  
  
"subscriptionId": "string",
  
  
"applyToSubscriptionId": "string",
  
  
"applyToTenantId": "string",
  
  
"applyToClientAppId": "string",
  
  
"applyToIdpTypeId": "string",
  
  
"applyToIdpInstanceId": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateProAuthUserQuestionnaire

POST
/api/management/v2/ProAuthUserQuestionnaire

Request Body

JSON
{
  
"id": "string",
  
"name": "string",
  
"isActive": true,
  
"subscriptionId": "string",
  
"applyToSubscriptionId": "string",
  
"applyToTenantId": "string",
  
"applyToClientAppId": "string",
  
"applyToIdpTypeId": "string",
  
"applyToIdpInstanceId": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"isActive": true,
  
"applyToType": 0,
  
"subscriptionId": "string",
  
"applyToSubscriptionId": "string",
  
"applyToTenantId": "string",
  
"applyToClientAppId": "string",
  
"applyToIdpTypeId": "string",
  
"applyToIdpInstanceId": "string",
  
"concurrencyToken": "string"
}

UpdateProAuthUserQuestionnaireBatch

PUT
/api/management/v2/ProAuthUserQuestionnaire/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"isActive": true,
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateProAuthUserQuestionnaireBatch

POST
/api/management/v2/ProAuthUserQuestionnaire/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"isActive": true,
  
  
"subscriptionId": "string",
  
  
"applyToSubscriptionId": "string",
  
  
"applyToTenantId": "string",
  
  
"applyToClientAppId": "string",
  
  
"applyToIdpTypeId": "string",
  
  
"applyToIdpInstanceId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteProAuthUserQuestionnaireBatch

DELETE
/api/management/v2/ProAuthUserQuestionnaire/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetProAuthUserQuestionnaire

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"isActive": true,
  
"applyToType": 0,
  
"subscriptionId": "string",
  
"applyToSubscriptionId": "string",
  
"applyToTenantId": "string",
  
"applyToClientAppId": "string",
  
"applyToIdpTypeId": "string",
  
"applyToIdpInstanceId": "string",
  
"concurrencyToken": "string"
}

UpdateProAuthUserQuestionnaire

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

Request Body

JSON
{
  
"id": "string",
  
"name": "string",
  
"isActive": true,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"isActive": true,
  
"applyToType": 0,
  
"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

JSON
{
  
"name": null,
  
"isActive": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"isActive": true,
  
"applyToType": 0,
  
"subscriptionId": "string",
  
"applyToSubscriptionId": "string",
  
"applyToTenantId": "string",
  
"applyToClientAppId": "string",
  
"applyToIdpTypeId": "string",
  
"applyToIdpInstanceId": "string",
  
"concurrencyToken": "string"
}

GetProAuthUserQuestionnaireItems

GET
/api/management/v2/ProAuthUserQuestionnaireItem

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"position": 0,
  
  
"questionnaireItemType": 0,
  
  
"key": "string",
  
  
"value": "string",
  
  
"labelId": "string",
  
  
"labelPlaceholderId": "string",
  
  
"isRequired": true,
  
  
"minLength": null,
  
  
"maxLength": null,
  
  
"validationFormat": 0,
  
  
"validationPattern": "string",
  
  
"proAuthUserQuestionnaireId": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateProAuthUserQuestionnaireItem

POST
/api/management/v2/ProAuthUserQuestionnaireItem

Request Body

JSON
{
  
"id": "string",
  
"position": 0,
  
"questionnaireItemType": 0,
  
"key": "string",
  
"value": "string",
  
"labelId": "string",
  
"labelPlaceholderId": "string",
  
"isRequired": true,
  
"minLength": null,
  
"maxLength": null,
  
"validationFormat": 0,
  
"validationPattern": "string",
  
"proAuthUserQuestionnaireId": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"position": 0,
  
"questionnaireItemType": 0,
  
"key": "string",
  
"value": "string",
  
"labelId": "string",
  
"labelPlaceholderId": "string",
  
"isRequired": true,
  
"minLength": null,
  
"maxLength": null,
  
"validationFormat": 0,
  
"validationPattern": "string",
  
"proAuthUserQuestionnaireId": "string",
  
"concurrencyToken": "string"
}

UpdateProAuthUserQuestionnaireItemBatch

PUT
/api/management/v2/ProAuthUserQuestionnaireItem/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"position": 0,
  
  
"questionnaireItemType": 0,
  
  
"key": "string",
  
  
"value": "string",
  
  
"labelId": "string",
  
  
"labelPlaceholderId": "string",
  
  
"isRequired": true,
  
  
"minLength": null,
  
  
"maxLength": null,
  
  
"validationFormat": 0,
  
  
"validationPattern": "string",
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateProAuthUserQuestionnaireItemBatch

POST
/api/management/v2/ProAuthUserQuestionnaireItem/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"position": 0,
  
  
"questionnaireItemType": 0,
  
  
"key": "string",
  
  
"value": "string",
  
  
"labelId": "string",
  
  
"labelPlaceholderId": "string",
  
  
"isRequired": true,
  
  
"minLength": null,
  
  
"maxLength": null,
  
  
"validationFormat": 0,
  
  
"validationPattern": "string",
  
  
"proAuthUserQuestionnaireId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteProAuthUserQuestionnaireItemBatch

DELETE
/api/management/v2/ProAuthUserQuestionnaireItem/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetProAuthUserQuestionnaireItem

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"position": 0,
  
"questionnaireItemType": 0,
  
"key": "string",
  
"value": "string",
  
"labelId": "string",
  
"labelPlaceholderId": "string",
  
"isRequired": true,
  
"minLength": null,
  
"maxLength": null,
  
"validationFormat": 0,
  
"validationPattern": "string",
  
"proAuthUserQuestionnaireId": "string",
  
"concurrencyToken": "string"
}

UpdateProAuthUserQuestionnaireItem

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

Request Body

JSON
{
  
"id": "string",
  
"position": 0,
  
"questionnaireItemType": 0,
  
"key": "string",
  
"value": "string",
  
"labelId": "string",
  
"labelPlaceholderId": "string",
  
"isRequired": true,
  
"minLength": null,
  
"maxLength": null,
  
"validationFormat": 0,
  
"validationPattern": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"position": 0,
  
"questionnaireItemType": 0,
  
"key": "string",
  
"value": "string",
  
"labelId": "string",
  
"labelPlaceholderId": "string",
  
"isRequired": true,
  
"minLength": null,
  
"maxLength": null,
  
"validationFormat": 0,
  
"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

JSON
{
  
"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

application/json
JSON
{
  
"id": "string",
  
"position": 0,
  
"questionnaireItemType": 0,
  
"key": "string",
  
"value": "string",
  
"labelId": "string",
  
"labelPlaceholderId": "string",
  
"isRequired": true,
  
"minLength": null,
  
"maxLength": null,
  
"validationFormat": 0,
  
"validationPattern": "string",
  
"proAuthUserQuestionnaireId": "string",
  
"concurrencyToken": "string"
}

GetProAuthUserRoles

GET
/api/management/v2/ProAuthUserRole

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"roleType": 0,
  
  
"applyToTenantId": "string",
  
  
"applyToIdpInstanceId": "string",
  
  
"proAuthUserId": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateProAuthUserRole

POST
/api/management/v2/ProAuthUserRole

Request Body

JSON
{
  
"id": "string",
  
"roleType": 0,
  
"applyToTenantId": "string",
  
"applyToIdpInstanceId": "string",
  
"proAuthUserId": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"roleType": 0,
  
"applyToTenantId": "string",
  
"applyToIdpInstanceId": "string",
  
"proAuthUserId": "string",
  
"concurrencyToken": "string"
}

UpdateProAuthUserRoleBatch

PUT
/api/management/v2/ProAuthUserRole/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"roleType": 0,
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateProAuthUserRoleBatch

POST
/api/management/v2/ProAuthUserRole/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"roleType": 0,
  
  
"applyToTenantId": "string",
  
  
"applyToIdpInstanceId": "string",
  
  
"proAuthUserId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteProAuthUserRoleBatch

DELETE
/api/management/v2/ProAuthUserRole/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetProAuthUserRole

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"roleType": 0,
  
"applyToTenantId": "string",
  
"applyToIdpInstanceId": "string",
  
"proAuthUserId": "string",
  
"concurrencyToken": "string"
}

UpdateProAuthUserRole

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

Request Body

JSON
{
  
"id": "string",
  
"roleType": 0,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"roleType": 0,
  
"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

JSON
{
  
"roleType": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"roleType": 0,
  
"applyToTenantId": "string",
  
"applyToIdpInstanceId": "string",
  
"proAuthUserId": "string",
  
"concurrencyToken": "string"
}

GetProAuthUserRolesByUser

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

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"roleType": 0,
  
  
"applyToTenantId": "string",
  
  
"applyToIdpInstanceId": "string",
  
  
"proAuthUserId": "string",
  
  
"concurrencyToken": "string"
  
}
]

ProductInformation


GetProductInformation

GET
/api/management/v2/ProductInformation

Responses

OK

JSON
{
  
"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"
  
}
}

GetSubscriptions

GET
/api/management/v2/Subscription

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"status": 0,
  
  
"customerId": "string",
  
  
"concurrencyToken": "string"
  
}
]

CreateSubscription

POST
/api/management/v2/Subscription

Request Body

JSON
{
  
"id": "string",
  
"name": "string",
  
"status": 0,
  
"customerId": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"status": 0,
  
"customerId": "string",
  
"concurrencyToken": "string"
}

UpdateSubscriptionBatch

PUT
/api/management/v2/Subscription/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"status": 0,
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateSubscriptionBatch

POST
/api/management/v2/Subscription/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"status": 0,
  
  
"customerId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteSubscriptionBatch

DELETE
/api/management/v2/Subscription/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetSubscription

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"status": 0,
  
"customerId": "string",
  
"concurrencyToken": "string"
}

UpdateSubscription

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

Request Body

JSON
{
  
"id": "string",
  
"name": "string",
  
"status": 0,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"status": 0,
  
"customerId": "string",
  
"concurrencyToken": "string"
}

DeleteSubscription

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

Responses

No Content


PatchSubscription

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

Request Body

JSON
{
  
"name": null,
  
"status": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"status": 0,
  
"customerId": "string",
  
"concurrencyToken": "string"
}

GetTenants

GET
/api/management/v2/Tenant

Responses

OK

application/json
JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"accessGrantConsent": 0,
  
  
"logoutConsent": 0,
  
  
"tenantKey": "string",
  
  
"hasConfigurationError": true,
  
  
"subscriptionId": "string",
  
  
"idpInstances": [...],
  
  
"mfaInstances": "[Circular Reference]",
  
  
"clientApps": "[Circular Reference]",
  
  
"concurrencyToken": "string"
  
}
]

CreateTenant

POST
/api/management/v2/Tenant

Request Body

JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"tenantKey": "string",
  
"subscriptionId": "string"
}

Responses

Created

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"tenantKey": "string",
  
"hasConfigurationError": true,
  
"subscriptionId": "string",
  
"idpInstances": [
  
  
{...}
  
],
  
"mfaInstances": "[Circular Reference]",
  
"clientApps": "[Circular Reference]",
  
"concurrencyToken": "string"
}

UpdateTenantBatch

PUT
/api/management/v2/Tenant/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"accessGrantConsent": 0,
  
  
"logoutConsent": 0,
  
  
"tenantKey": "string",
  
  
"concurrencyToken": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

CreateTenantBatch

POST
/api/management/v2/Tenant/batch

Request Body

JSON
[
  
{
  
  
"id": "string",
  
  
"name": "string",
  
  
"accessGrantConsent": 0,
  
  
"logoutConsent": 0,
  
  
"tenantKey": "string",
  
  
"subscriptionId": "string"
  
}
]

Responses

OK

application/json
JSON
[
]

DeleteTenantBatch

DELETE
/api/management/v2/Tenant/batch

Request Body

JSON
[
  
"string"
]

Responses

No Content


GetTenant

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

Responses

OK

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"tenantKey": "string",
  
"hasConfigurationError": true,
  
"subscriptionId": "string",
  
"idpInstances": [
  
  
{...}
  
],
  
"mfaInstances": "[Circular Reference]",
  
"clientApps": "[Circular Reference]",
  
"concurrencyToken": "string"
}

UpdateTenant

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

Request Body

JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"tenantKey": "string",
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"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

JSON
{
  
"name": null,
  
"accessGrantConsent": null,
  
"logoutConsent": null,
  
"tenantKey": null,
  
"concurrencyToken": "string"
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"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

JSON
{
  
"relatedIds": [
  
  
"string"
  
]
}

Responses

Accepted

application/json
JSON
{
  
"id": "string",
  
"name": "string",
  
"accessGrantConsent": 0,
  
"logoutConsent": 0,
  
"tenantKey": "string",
  
"hasConfigurationError": true,
  
"subscriptionId": "string",
  
"idpInstances": [
  
  
{...}
  
],
  
"mfaInstances": "[Circular Reference]",
  
"clientApps": "[Circular Reference]",
  
"concurrencyToken": "string"
}

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