Version v3.2.0
Deprecated
The Management API v1 is deprecated as of ProAuth 3.0. Use the Management API v2 for all new integrations. v1 remains available for backward compatibility but will be removed in a future major release.
CertStore
Operations
GET/api/management/v1/CertStore/type/{type}GET/api/management/v1/CertStore/type/{type}/subscription/{subscriptionId}GET/api/management/v1/CertStore/type/{type}/tenant/{tenantId}GET/api/management/v1/CertStore/type/{type}/idpinstance/{idpInstanceId}GET/api/management/v1/CertStorePOST/api/management/v1/CertStorePOST/api/management/v1/CertStore/createorupdateGET/api/management/v1/CertStore/{id}PUT/api/management/v1/CertStore/{id}DELETE/api/management/v1/CertStore/{id}PATCH/api/management/v1/CertStore/{id}PUT/api/management/v1/CertStore/batchPOST/api/management/v1/CertStore/batchDELETE/api/management/v1/CertStore/batchPATCH/api/management/v1/CertStore/batchPOST/api/management/v1/CertStore/createorupdate/batch
GetCertStoresByType
GET
/api/management/v1/CertStore/type/{type}
Responses
OK
application/json
JSON { "id": "string", "name": "string", "description": "string", "certType": "string", "certificate": "string", "password": "string", "thumbprint": "string", "validFrom": "string", "validTo": "string", "issuer": "string", "serialNumber": "string", "subject": "string", "applyToType": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "idpInstances": [...] }
[
]
GetCertStoresBySubscription
GET
/api/management/v1/CertStore/type/{type}/subscription/{subscriptionId}
Responses
OK
application/json
JSON
[
]
GetCertStoresByTenant
GET
/api/management/v1/CertStore/type/{type}/tenant/{tenantId}
Responses
OK
application/json
JSON
[
]
GetCertStoresByInstance
GET
/api/management/v1/CertStore/type/{type}/idpinstance/{idpInstanceId}
Responses
OK
application/json
JSON
[
]
CreateCertStore
POST
/api/management/v1/CertStore
Request Body
JSON "id": "string", "name": "string", "description": "string", "certType": "string", "certificate": "string", "password": "string", "thumbprint": "string", "validFrom": "string", "validTo": "string", "issuer": "string", "serialNumber": "string", "subject": "string", "applyToType": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "idpInstances": [ {...} ]
{
}
Responses
Created
application/json
JSON "id": "string", "name": "string", "description": "string", "certType": "string", "certificate": "string", "password": "string", "thumbprint": "string", "validFrom": "string", "validTo": "string", "issuer": "string", "serialNumber": "string", "subject": "string", "applyToType": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "idpInstances": [ {...} ]
{
}
CreateOrUpdateCertStore
POST
/api/management/v1/CertStore/createorupdate
Request Body
JSON "id": "string", "name": "string", "description": "string", "certType": "string", "certificate": "string", "password": "string", "thumbprint": "string", "validFrom": "string", "validTo": "string", "issuer": "string", "serialNumber": "string", "subject": "string", "applyToType": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "idpInstances": [ {...} ]
{
}
Responses
Created
application/json
JSON "id": "string", "name": "string", "description": "string", "certType": "string", "certificate": "string", "password": "string", "thumbprint": "string", "validFrom": "string", "validTo": "string", "issuer": "string", "serialNumber": "string", "subject": "string", "applyToType": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "idpInstances": [ {...} ]
{
}
GetCertStore
GET
/api/management/v1/CertStore/{id}
Responses
OK
application/json
JSON "id": "string", "name": "string", "description": "string", "certType": "string", "certificate": "string", "password": "string", "thumbprint": "string", "validFrom": "string", "validTo": "string", "issuer": "string", "serialNumber": "string", "subject": "string", "applyToType": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "idpInstances": [ {...} ]
{
}
UpdateCertStore
PUT
/api/management/v1/CertStore/{id}
Request Body
JSON "id": "string", "name": "string", "description": "string", "certType": "string", "certificate": "string", "password": "string", "thumbprint": "string", "validFrom": "string", "validTo": "string", "issuer": "string", "serialNumber": "string", "subject": "string", "applyToType": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "idpInstances": [ {...} ]
{
}
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "description": "string", "certType": "string", "certificate": "string", "password": "string", "thumbprint": "string", "validFrom": "string", "validTo": "string", "issuer": "string", "serialNumber": "string", "subject": "string", "applyToType": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "idpInstances": [ {...} ]
{
}
PatchCertStore
PATCH
/api/management/v1/CertStore/{id}
Request Body
JSON { "op": "string", "path": "string", "from": "string", "value": null }
[
]
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "description": "string", "certType": "string", "certificate": "string", "password": "string", "thumbprint": "string", "validFrom": "string", "validTo": "string", "issuer": "string", "serialNumber": "string", "subject": "string", "applyToType": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "idpInstances": [ {...} ]
{
}
UpdateCertStores
CreateCertStores
PatchCertStores
PATCH
/api/management/v1/CertStore/batch
Request Body
JSON { "ids": [...], "patch": null }
[
]
Responses
Accepted
application/json
JSON { "id": "string", "name": "string", "description": "string", "certType": "string", "certificate": "string", "password": "string", "thumbprint": "string", "validFrom": "string", "validTo": "string", "issuer": "string", "serialNumber": "string", "subject": "string", "applyToType": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "idpInstances": [...] }
[
]
CreateOrUpdateCertStores
ClaimRule
Operations
GET/api/management/v1/ClaimRulePOST/api/management/v1/ClaimRulePOST/api/management/v1/ClaimRule/createorupdateGET/api/management/v1/ClaimRule/{id}PUT/api/management/v1/ClaimRule/{id}DELETE/api/management/v1/ClaimRule/{id}PATCH/api/management/v1/ClaimRule/{id}PUT/api/management/v1/ClaimRule/batchPOST/api/management/v1/ClaimRule/batchDELETE/api/management/v1/ClaimRule/batchPATCH/api/management/v1/ClaimRule/batchPOST/api/management/v1/ClaimRule/createorupdate/batch
GetClaimRules
GET
/api/management/v1/ClaimRule
Responses
OK
application/json
JSON { "id": "string", "name": "string", "ruleType": "string", "filterTarget": "string", "transformTarget": "string", "ruleLevel": "string", "destination": "string", "priority": 0, "typeEvaluationRule": "string", "valueEvaluationRule": "string", "typeTransformationRule": "string", "valueTransformationRule": "string", "typeTransformationReplacement": "string", "valueTransformationReplacement": "string", "isActive": true, "subscriptionId": "string", "applyToIdpInstanceId": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "clientApps": "[Circular Reference]" }
[
]
CreateClaimRule
POST
/api/management/v1/ClaimRule
Request Body
JSON "id": "string", "name": "string", "ruleType": "string", "filterTarget": "string", "transformTarget": "string", "ruleLevel": "string", "destination": "string", "priority": 0, "typeEvaluationRule": "string", "valueEvaluationRule": "string", "typeTransformationRule": "string", "valueTransformationRule": "string", "typeTransformationReplacement": "string", "valueTransformationReplacement": "string", "isActive": true, "subscriptionId": "string", "applyToIdpInstanceId": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "clientApps": "[Circular Reference]"
{
}
Responses
Created
application/json
JSON "id": "string", "name": "string", "ruleType": "string", "filterTarget": "string", "transformTarget": "string", "ruleLevel": "string", "destination": "string", "priority": 0, "typeEvaluationRule": "string", "valueEvaluationRule": "string", "typeTransformationRule": "string", "valueTransformationRule": "string", "typeTransformationReplacement": "string", "valueTransformationReplacement": "string", "isActive": true, "subscriptionId": "string", "applyToIdpInstanceId": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "clientApps": "[Circular Reference]"
{
}
CreateOrUpdateClaimRule
POST
/api/management/v1/ClaimRule/createorupdate
Request Body
JSON "id": "string", "name": "string", "ruleType": "string", "filterTarget": "string", "transformTarget": "string", "ruleLevel": "string", "destination": "string", "priority": 0, "typeEvaluationRule": "string", "valueEvaluationRule": "string", "typeTransformationRule": "string", "valueTransformationRule": "string", "typeTransformationReplacement": "string", "valueTransformationReplacement": "string", "isActive": true, "subscriptionId": "string", "applyToIdpInstanceId": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "clientApps": "[Circular Reference]"
{
}
Responses
Created
application/json
JSON "id": "string", "name": "string", "ruleType": "string", "filterTarget": "string", "transformTarget": "string", "ruleLevel": "string", "destination": "string", "priority": 0, "typeEvaluationRule": "string", "valueEvaluationRule": "string", "typeTransformationRule": "string", "valueTransformationRule": "string", "typeTransformationReplacement": "string", "valueTransformationReplacement": "string", "isActive": true, "subscriptionId": "string", "applyToIdpInstanceId": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "clientApps": "[Circular Reference]"
{
}
GetClaimRule
GET
/api/management/v1/ClaimRule/{id}
Responses
OK
application/json
JSON "id": "string", "name": "string", "ruleType": "string", "filterTarget": "string", "transformTarget": "string", "ruleLevel": "string", "destination": "string", "priority": 0, "typeEvaluationRule": "string", "valueEvaluationRule": "string", "typeTransformationRule": "string", "valueTransformationRule": "string", "typeTransformationReplacement": "string", "valueTransformationReplacement": "string", "isActive": true, "subscriptionId": "string", "applyToIdpInstanceId": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "clientApps": "[Circular Reference]"
{
}
UpdateClaimRule
PUT
/api/management/v1/ClaimRule/{id}
Request Body
JSON "id": "string", "name": "string", "ruleType": "string", "filterTarget": "string", "transformTarget": "string", "ruleLevel": "string", "destination": "string", "priority": 0, "typeEvaluationRule": "string", "valueEvaluationRule": "string", "typeTransformationRule": "string", "valueTransformationRule": "string", "typeTransformationReplacement": "string", "valueTransformationReplacement": "string", "isActive": true, "subscriptionId": "string", "applyToIdpInstanceId": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "clientApps": "[Circular Reference]"
{
}
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "ruleType": "string", "filterTarget": "string", "transformTarget": "string", "ruleLevel": "string", "destination": "string", "priority": 0, "typeEvaluationRule": "string", "valueEvaluationRule": "string", "typeTransformationRule": "string", "valueTransformationRule": "string", "typeTransformationReplacement": "string", "valueTransformationReplacement": "string", "isActive": true, "subscriptionId": "string", "applyToIdpInstanceId": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "clientApps": "[Circular Reference]"
{
}
PatchClaimRule
PATCH
/api/management/v1/ClaimRule/{id}
Request Body
JSON { "op": "string", "path": "string", "from": "string", "value": null }
[
]
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "ruleType": "string", "filterTarget": "string", "transformTarget": "string", "ruleLevel": "string", "destination": "string", "priority": 0, "typeEvaluationRule": "string", "valueEvaluationRule": "string", "typeTransformationRule": "string", "valueTransformationRule": "string", "typeTransformationReplacement": "string", "valueTransformationReplacement": "string", "isActive": true, "subscriptionId": "string", "applyToIdpInstanceId": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "clientApps": "[Circular Reference]"
{
}
UpdateClaimRules
CreateClaimRules
PatchClaimRules
PATCH
/api/management/v1/ClaimRule/batch
Request Body
JSON
[
]
Responses
Accepted
application/json
JSON { "id": "string", "name": "string", "ruleType": "string", "filterTarget": "string", "transformTarget": "string", "ruleLevel": "string", "destination": "string", "priority": 0, "typeEvaluationRule": "string", "valueEvaluationRule": "string", "typeTransformationRule": "string", "valueTransformationRule": "string", "typeTransformationReplacement": "string", "valueTransformationReplacement": "string", "isActive": true, "subscriptionId": "string", "applyToIdpInstanceId": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "clientApps": "[Circular Reference]" }
[
]
CreateOrUpdateClaimRules
CustomAsset
Operations
GET/api/management/v1/CustomAsset/{id}PUT/api/management/v1/CustomAsset/{id}DELETE/api/management/v1/CustomAsset/{id}PATCH/api/management/v1/CustomAsset/{id}POST/api/management/v1/CustomAsset/createGET/api/management/v1/CustomAsset/mimetypesGET/api/management/v1/CustomAssetPOST/api/management/v1/CustomAssetPOST/api/management/v1/CustomAsset/createorupdatePUT/api/management/v1/CustomAsset/batchPOST/api/management/v1/CustomAsset/batchDELETE/api/management/v1/CustomAsset/batchPATCH/api/management/v1/CustomAsset/batchPOST/api/management/v1/CustomAsset/createorupdate/batch
GetCustomAsset
GET
/api/management/v1/CustomAsset/{id}
Responses
OK
application/json
JSON "location": "string", "mimetype": "string", "data": "string", "size": 0, "fileName": "string"
{
}
UpdateCustomAsset
PatchCustomAsset
CreateCustomAssetByExpander
POST
/api/management/v1/CustomAsset/create
Request Body
JSON "mimetype": "string", "assetFileName": "string", "data": "string", "applyToType": "string", "tenantId": "string", "clientAppId": "string", "subscriptionId": "string", "location": "string"
{
}
Responses
Created
application/json
JSON "location": "string", "mimetype": "string", "data": "string", "size": 0, "fileName": "string"
{
}
GetSupportedMimetypes
GET
/api/management/v1/CustomAsset/mimetypes
Responses
OK
application/json
JSON "string"
[
]
GetCustomAssets
GET
/api/management/v1/CustomAsset
Responses
OK
application/json
JSON { "location": "string", "mimetype": "string", "data": "string", "size": 0, "fileName": "string" }
[
]
CreateCustomAsset
CreateOrUpdateCustomAsset
UpdateCustomAssets
CreateCustomAssets
DeleteCustomAssets
PatchCustomAssets
CreateOrUpdateCustomAssets
Customer
Operations
GET/api/management/v1/CustomerPOST/api/management/v1/CustomerPUT/api/management/v1/Customer/batchPOST/api/management/v1/Customer/batchDELETE/api/management/v1/Customer/batchPATCH/api/management/v1/Customer/batchGET/api/management/v1/Customer/{id}PUT/api/management/v1/Customer/{id}DELETE/api/management/v1/Customer/{id}PATCH/api/management/v1/Customer/{id}POST/api/management/v1/Customer/createorupdatePOST/api/management/v1/Customer/createorupdate/batch
GetCustomers
GET
/api/management/v1/Customer
Responses
OK
application/json
JSON { "id": "string", "name": "string", "address": "string" }
[
]
CreateCustomer
UpdateCustomers
CreateCustomers
PatchCustomers
GetCustomer
GET
/api/management/v1/Customer/{id}
Responses
OK
application/json
JSON "id": "string", "name": "string", "address": "string"
{
}
UpdateCustomer
PatchCustomer
CreateOrUpdateCustomer
CreateOrUpdateCustomers
CustomView
Operations
GET/api/management/v1/CustomView/{id}PUT/api/management/v1/CustomView/{id}DELETE/api/management/v1/CustomView/{id}PATCH/api/management/v1/CustomView/{id}POST/api/management/v1/CustomView/viewtemplate/viewGET/api/management/v1/CustomView/viewtemplate/namesGET/api/management/v1/CustomView/viewtemplate/content/{viewName}GET/api/management/v1/CustomViewPOST/api/management/v1/CustomViewPOST/api/management/v1/CustomView/createorupdatePUT/api/management/v1/CustomView/batchPOST/api/management/v1/CustomView/batchDELETE/api/management/v1/CustomView/batchPATCH/api/management/v1/CustomView/batchPOST/api/management/v1/CustomView/createorupdate/batch
GetCustomView
GET
/api/management/v1/CustomView/{id}
Responses
OK
application/json
JSON "location": "string", "content": "string"
{
}
UpdateCustomView
PatchCustomView
CreateCustomViewFromTemplate
GetAllTemplateViews
GET
/api/management/v1/CustomView/viewtemplate/names
Responses
OK
application/json
JSON
[
]
GetTemplateViewContent
GET
/api/management/v1/CustomView/viewtemplate/content/{viewName}
Responses
OK
application/json
JSON
"string"
GetCustomViews
GET
/api/management/v1/CustomView
Responses
OK
application/json
JSON { "location": "string", "content": "string" }
[
]
CreateCustomView
CreateOrUpdateCustomView
UpdateCustomViews
CreateCustomViews
PatchCustomViews
CreateOrUpdateCustomViews
IdpInstance
Operations
GET/api/management/v1/IdpInstance/tenant/{tenantId}/clientapp/{clientAppId}GET/api/management/v1/IdpInstance/tenant/{tenantId}GET/api/management/v1/IdpInstance/subscription/{subscriptionId}POST/api/management/v1/IdpInstance/{idpInstance}/scim/tokenGET/api/management/v1/IdpInstance/{idpInstance}/healthGET/api/management/v1/IdpInstancePOST/api/management/v1/IdpInstancePOST/api/management/v1/IdpInstance/createorupdateGET/api/management/v1/IdpInstance/{id}PUT/api/management/v1/IdpInstance/{id}DELETE/api/management/v1/IdpInstance/{id}PATCH/api/management/v1/IdpInstance/{id}PUT/api/management/v1/IdpInstance/batchPOST/api/management/v1/IdpInstance/batchDELETE/api/management/v1/IdpInstance/batchPATCH/api/management/v1/IdpInstance/batchPOST/api/management/v1/IdpInstance/createorupdate/batch
GetIdpInstancesByTenantAndClientApp
GET
/api/management/v1/IdpInstance/tenant/{tenantId}/clientapp/{clientAppId}
Responses
OK
application/json
JSON { "id": "string", "name": "string", "position": 0, "isActive": true, "treatSecondFactorClaimsAsConfirmed": true, "autoCreateProAuthUser": true, "isHidden": true, "icon": "string", "idpTypeId": "string", "idpFactoryType": "string", "subscriptionId": "string", "hasConfigurationError": true, "options": [...], "twoFactorInstances": [...], "tenants": [...], "clientApps": [...], "certStores": [...], "metadata": [...] }
[
]
GetIdpInstancesByTenantId
GET
/api/management/v1/IdpInstance/tenant/{tenantId}
Responses
OK
application/json
JSON { "id": "string", "name": "string", "position": 0, "isActive": true, "treatSecondFactorClaimsAsConfirmed": true, "autoCreateProAuthUser": true, "isHidden": true, "icon": "string", "idpTypeId": "string", "idpFactoryType": "string", "subscriptionId": "string", "hasConfigurationError": true, "options": [...], "twoFactorInstances": [...], "tenants": [...], "clientApps": [...], "certStores": [...], "metadata": [...] }
[
]
GetIdpInstancesBySubscription
GET
/api/management/v1/IdpInstance/subscription/{subscriptionId}
Responses
OK
application/json
JSON
[
]
GetIdpInstanceHealthStatus
GET
/api/management/v1/IdpInstance/{idpInstance}/health
Responses
OK
application/json
JSON "instanceId": "string", "hasConfigurationError": true, "isOperational": true
{
}
CreateIdpInstance
POST
/api/management/v1/IdpInstance
Request Body
JSON "id": "string", "name": "string", "position": 0, "isActive": true, "treatSecondFactorClaimsAsConfirmed": true, "autoCreateProAuthUser": true, "isHidden": true, "icon": "string", "idpTypeId": "string", "idpFactoryType": "string", "subscriptionId": "string", "hasConfigurationError": true, "options": [ {...} ], "twoFactorInstances": [ {...} ], "tenants": [ ], "clientApps": [ ], "certStores": [ {...} ], "metadata": [ {...} ]
{
}
Responses
Created
application/json
JSON "id": "string", "name": "string", "position": 0, "isActive": true, "treatSecondFactorClaimsAsConfirmed": true, "autoCreateProAuthUser": true, "isHidden": true, "icon": "string", "idpTypeId": "string", "idpFactoryType": "string", "subscriptionId": "string", "hasConfigurationError": true, "options": [ {...} ], "twoFactorInstances": [ {...} ], "tenants": [ ], "clientApps": [ ], "certStores": [ {...} ], "metadata": [ {...} ]
{
}
CreateOrUpdateIdpInstance
POST
/api/management/v1/IdpInstance/createorupdate
Request Body
JSON "id": "string", "name": "string", "position": 0, "isActive": true, "treatSecondFactorClaimsAsConfirmed": true, "autoCreateProAuthUser": true, "isHidden": true, "icon": "string", "idpTypeId": "string", "idpFactoryType": "string", "subscriptionId": "string", "hasConfigurationError": true, "options": [ {...} ], "twoFactorInstances": [ {...} ], "tenants": [ ], "clientApps": [ ], "certStores": [ {...} ], "metadata": [ {...} ]
{
}
Responses
Created
application/json
JSON "id": "string", "name": "string", "position": 0, "isActive": true, "treatSecondFactorClaimsAsConfirmed": true, "autoCreateProAuthUser": true, "isHidden": true, "icon": "string", "idpTypeId": "string", "idpFactoryType": "string", "subscriptionId": "string", "hasConfigurationError": true, "options": [ {...} ], "twoFactorInstances": [ {...} ], "tenants": [ ], "clientApps": [ ], "certStores": [ {...} ], "metadata": [ {...} ]
{
}
GetIdpInstance
GET
/api/management/v1/IdpInstance/{id}
Responses
OK
application/json
JSON "id": "string", "name": "string", "position": 0, "isActive": true, "treatSecondFactorClaimsAsConfirmed": true, "autoCreateProAuthUser": true, "isHidden": true, "icon": "string", "idpTypeId": "string", "idpFactoryType": "string", "subscriptionId": "string", "hasConfigurationError": true, "options": [ {...} ], "twoFactorInstances": [ {...} ], "tenants": [ ], "clientApps": [ ], "certStores": [ {...} ], "metadata": [ {...} ]
{
}
UpdateIdpInstance
PUT
/api/management/v1/IdpInstance/{id}
Request Body
JSON "id": "string", "name": "string", "position": 0, "isActive": true, "treatSecondFactorClaimsAsConfirmed": true, "autoCreateProAuthUser": true, "isHidden": true, "icon": "string", "idpTypeId": "string", "idpFactoryType": "string", "subscriptionId": "string", "hasConfigurationError": true, "options": [ {...} ], "twoFactorInstances": [ {...} ], "tenants": [ ], "clientApps": [ ], "certStores": [ {...} ], "metadata": [ {...} ]
{
}
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "position": 0, "isActive": true, "treatSecondFactorClaimsAsConfirmed": true, "autoCreateProAuthUser": true, "isHidden": true, "icon": "string", "idpTypeId": "string", "idpFactoryType": "string", "subscriptionId": "string", "hasConfigurationError": true, "options": [ {...} ], "twoFactorInstances": [ {...} ], "tenants": [ ], "clientApps": [ ], "certStores": [ {...} ], "metadata": [ {...} ]
{
}
PatchIdpInstance
PATCH
/api/management/v1/IdpInstance/{id}
Request Body
JSON { "op": "string", "path": "string", "from": "string", "value": null }
[
]
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "position": 0, "isActive": true, "treatSecondFactorClaimsAsConfirmed": true, "autoCreateProAuthUser": true, "isHidden": true, "icon": "string", "idpTypeId": "string", "idpFactoryType": "string", "subscriptionId": "string", "hasConfigurationError": true, "options": [ {...} ], "twoFactorInstances": [ {...} ], "tenants": [ ], "clientApps": [ ], "certStores": [ {...} ], "metadata": [ {...} ]
{
}
UpdateIdpInstances
CreateIdpInstances
DeleteIdpInstances
PatchIdpInstances
PATCH
/api/management/v1/IdpInstance/batch
Request Body
JSON
[
]
Responses
Accepted
application/json
JSON { "id": "string", "name": "string", "position": 0, "isActive": true, "treatSecondFactorClaimsAsConfirmed": true, "autoCreateProAuthUser": true, "isHidden": true, "icon": "string", "idpTypeId": "string", "idpFactoryType": "string", "subscriptionId": "string", "hasConfigurationError": true, "options": [...], "twoFactorInstances": [...], "tenants": [...], "clientApps": [...], "certStores": [...], "metadata": [...] }
[
]
CreateOrUpdateIdpInstances
IdpInstanceMetadata
Operations
GET/api/management/v1/IdpInstance/{idpInstanceId}/IdpInstanceMetadata/idpInstanceIdGET/api/management/v1/IdpInstance/{idpInstanceId}/IdpInstanceMetadata/{key}PUT/api/management/v1/IdpInstance/{idpInstanceId}/IdpInstanceMetadata/{key}DELETE/api/management/v1/IdpInstance/{idpInstanceId}/IdpInstanceMetadata/{key}PATCH/api/management/v1/IdpInstance/{idpInstanceId}/IdpInstanceMetadata/{key}PUT/api/management/v1/IdpInstance/{idpInstanceId}/IdpInstanceMetadata/batchPOST/api/management/v1/IdpInstance/{idpInstanceId}/IdpInstanceMetadata/batchDELETE/api/management/v1/IdpInstance/{idpInstanceId}/IdpInstanceMetadata/batchPATCH/api/management/v1/IdpInstance/{idpInstanceId}/IdpInstanceMetadata/batchGET/api/management/v1/IdpInstance/{idpInstanceId}/IdpInstanceMetadataPOST/api/management/v1/IdpInstance/{idpInstanceId}/IdpInstanceMetadataPOST/api/management/v1/IdpInstance/{idpInstanceId}/IdpInstanceMetadata/createorupdatePOST/api/management/v1/IdpInstance/{idpInstanceId}/IdpInstanceMetadata/createorupdate/batch
GetIdpInstanceMetadataByIdpInstanceId
GET
/api/management/v1/IdpInstance/{idpInstanceId}/IdpInstanceMetadata/idpInstanceId
Responses
OK
application/json
JSON { "idpInstanceId": "string", "key": "string", "value": "string" }
[
]
GetIdpInstanceMetadata
GET
/api/management/v1/IdpInstance/{idpInstanceId}/IdpInstanceMetadata/{key}
Responses
OK
application/json
JSON "idpInstanceId": "string", "key": "string", "value": "string"
{
}
UpdateIdpInstanceMetadata
DeleteIdpInstanceMetadata
DELETE
/api/management/v1/IdpInstance/{idpInstanceId}/IdpInstanceMetadata/{key}
Responses
No Content
PatchIdpInstanceMetadata
UpdateIdpInstanceMetadatas
CreateIdpInstanceMetadatas
DeleteIdpInstanceMetadatas
PatchIdpInstanceMetadatas
GetIdpInstanceMetadatas
GET
/api/management/v1/IdpInstance/{idpInstanceId}/IdpInstanceMetadata
Responses
OK
application/json
JSON
[
]
CreateIdpInstanceMetadata
CreateOrUpdateIdpInstanceMetadata
CreateOrUpdateIdpInstanceMetadatas
IdpType
Operations
GET/api/management/v1/IdpType/name/{name}GET/api/management/v1/IdpTypePOST/api/management/v1/IdpTypePUT/api/management/v1/IdpType/batchPOST/api/management/v1/IdpType/batchDELETE/api/management/v1/IdpType/batchPATCH/api/management/v1/IdpType/batchGET/api/management/v1/IdpType/{id}PUT/api/management/v1/IdpType/{id}DELETE/api/management/v1/IdpType/{id}PATCH/api/management/v1/IdpType/{id}POST/api/management/v1/IdpType/createorupdatePOST/api/management/v1/IdpType/createorupdate/batch
GetIdpTypeByName
GET
/api/management/v1/IdpType/name/{name}
Responses
OK
application/json
JSON "id": "string", "name": "string", "providerType": "string", "factoryType": "string", "isActive": true, "twoFactorInstances": "[Circular Reference]"
{
}
GetIdpTypes
GET
/api/management/v1/IdpType
Responses
OK
application/json
JSON { "id": "string", "name": "string", "providerType": "string", "factoryType": "string", "isActive": true, "twoFactorInstances": "[Circular Reference]" }
[
]
CreateIdpType
POST
/api/management/v1/IdpType
Request Body
JSON "id": "string", "name": "string", "providerType": "string", "factoryType": "string", "isActive": true, "twoFactorInstances": "[Circular Reference]"
{
}
Responses
Created
application/json
JSON "id": "string", "name": "string", "providerType": "string", "factoryType": "string", "isActive": true, "twoFactorInstances": "[Circular Reference]"
{
}
UpdateIdpTypes
CreateIdpTypes
PatchIdpTypes
GetIdpType
GET
/api/management/v1/IdpType/{id}
Responses
OK
application/json
JSON "id": "string", "name": "string", "providerType": "string", "factoryType": "string", "isActive": true, "twoFactorInstances": "[Circular Reference]"
{
}
UpdateIdpType
PUT
/api/management/v1/IdpType/{id}
Request Body
JSON "id": "string", "name": "string", "providerType": "string", "factoryType": "string", "isActive": true, "twoFactorInstances": "[Circular Reference]"
{
}
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "providerType": "string", "factoryType": "string", "isActive": true, "twoFactorInstances": "[Circular Reference]"
{
}
PatchIdpType
PATCH
/api/management/v1/IdpType/{id}
Request Body
JSON { "op": "string", "path": "string", "from": "string", "value": null }
[
]
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "providerType": "string", "factoryType": "string", "isActive": true, "twoFactorInstances": "[Circular Reference]"
{
}
CreateOrUpdateIdpType
POST
/api/management/v1/IdpType/createorupdate
Request Body
JSON "id": "string", "name": "string", "providerType": "string", "factoryType": "string", "isActive": true, "twoFactorInstances": "[Circular Reference]"
{
}
Responses
Created
application/json
JSON "id": "string", "name": "string", "providerType": "string", "factoryType": "string", "isActive": true, "twoFactorInstances": "[Circular Reference]"
{
}
CreateOrUpdateIdpTypes
IpAddressRange
Operations
GET/api/management/v1/IpAddressRange/tenant/{tenantId}GET/api/management/v1/IpAddressRangePOST/api/management/v1/IpAddressRangePOST/api/management/v1/IpAddressRange/createorupdateGET/api/management/v1/IpAddressRange/{id}PUT/api/management/v1/IpAddressRange/{id}DELETE/api/management/v1/IpAddressRange/{id}PATCH/api/management/v1/IpAddressRange/{id}PUT/api/management/v1/IpAddressRange/batchPOST/api/management/v1/IpAddressRange/batchDELETE/api/management/v1/IpAddressRange/batchPATCH/api/management/v1/IpAddressRange/batchPOST/api/management/v1/IpAddressRange/createorupdate/batch
GetIpAddressRangesForTenantId
GET
/api/management/v1/IpAddressRange/tenant/{tenantId}
Responses
OK
application/json
JSON { "id": "string", "lower": "string", "upper": "string", "tenantId": "string" }
[
]
GetIpAddressRanges
GET
/api/management/v1/IpAddressRange
Responses
OK
application/json
JSON { "id": "string", "lower": "string", "upper": "string", "tenantId": "string" }
[
]
CreateIpAddressRange
CreateOrUpdateIpAddressRange
GetIpAddressRange
GET
/api/management/v1/IpAddressRange/{id}
Responses
OK
application/json
JSON "id": "string", "lower": "string", "upper": "string", "tenantId": "string"
{
}
UpdateIpAddressRange
PatchIpAddressRange
UpdateIpAddressRanges
CreateIpAddressRanges
DeleteIpAddressRanges
PatchIpAddressRanges
CreateOrUpdateIpAddressRanges
Option
Operations
GET/api/management/v1/Option/type/{type}/ref/{refId}/name/{name}/valueGET/api/management/v1/Option/type/{type}/ref/{refId}/name/{name}GET/api/management/v1/Option/type/{type}/ref/{refId}GET/api/management/v1/OptionPOST/api/management/v1/OptionPOST/api/management/v1/Option/createorupdateGET/api/management/v1/Option/{id}PUT/api/management/v1/Option/{id}DELETE/api/management/v1/Option/{id}PATCH/api/management/v1/Option/{id}PUT/api/management/v1/Option/batchPOST/api/management/v1/Option/batchDELETE/api/management/v1/Option/batchPATCH/api/management/v1/Option/batchPOST/api/management/v1/Option/createorupdate/batch
GetOptionValueByName
GET
/api/management/v1/Option/type/{type}/ref/{refId}/name/{name}/value
Responses
OK
application/json
JSON
"string"
GetOptionByType
GET
/api/management/v1/Option/type/{type}/ref/{refId}/name/{name}
Responses
OK
application/json
JSON "id": "string", "name": "string", "value": "string", "hasConfigurationError": true, "applyToIdpInstanceId": "string", "applyToTwoFactorInstanceId": "string", "applyToTenantId": "string"
{
}
GetOptionsByType
GET
/api/management/v1/Option/type/{type}/ref/{refId}
Responses
OK
application/json
JSON { "id": "string", "name": "string", "value": "string", "hasConfigurationError": true, "applyToIdpInstanceId": "string", "applyToTwoFactorInstanceId": "string", "applyToTenantId": "string" }
[
]
GetOptions
GET
/api/management/v1/Option
Responses
OK
application/json
JSON { "id": "string", "name": "string", "value": "string", "hasConfigurationError": true, "applyToIdpInstanceId": "string", "applyToTwoFactorInstanceId": "string", "applyToTenantId": "string" }
[
]
CreateOption
POST
/api/management/v1/Option
Request Body
JSON "id": "string", "name": "string", "value": "string", "hasConfigurationError": true, "applyToIdpInstanceId": "string", "applyToTwoFactorInstanceId": "string", "applyToTenantId": "string"
{
}
Responses
Created
application/json
JSON "id": "string", "name": "string", "value": "string", "hasConfigurationError": true, "applyToIdpInstanceId": "string", "applyToTwoFactorInstanceId": "string", "applyToTenantId": "string"
{
}
CreateOrUpdateOption
POST
/api/management/v1/Option/createorupdate
Request Body
JSON "id": "string", "name": "string", "value": "string", "hasConfigurationError": true, "applyToIdpInstanceId": "string", "applyToTwoFactorInstanceId": "string", "applyToTenantId": "string"
{
}
Responses
Created
application/json
JSON "id": "string", "name": "string", "value": "string", "hasConfigurationError": true, "applyToIdpInstanceId": "string", "applyToTwoFactorInstanceId": "string", "applyToTenantId": "string"
{
}
GetOption
GET
/api/management/v1/Option/{id}
Responses
OK
application/json
JSON "id": "string", "name": "string", "value": "string", "hasConfigurationError": true, "applyToIdpInstanceId": "string", "applyToTwoFactorInstanceId": "string", "applyToTenantId": "string"
{
}
UpdateOption
PUT
/api/management/v1/Option/{id}
Request Body
JSON "id": "string", "name": "string", "value": "string", "hasConfigurationError": true, "applyToIdpInstanceId": "string", "applyToTwoFactorInstanceId": "string", "applyToTenantId": "string"
{
}
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "value": "string", "hasConfigurationError": true, "applyToIdpInstanceId": "string", "applyToTwoFactorInstanceId": "string", "applyToTenantId": "string"
{
}
PatchOption
PATCH
/api/management/v1/Option/{id}
Request Body
JSON { "op": "string", "path": "string", "from": "string", "value": null }
[
]
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "value": "string", "hasConfigurationError": true, "applyToIdpInstanceId": "string", "applyToTwoFactorInstanceId": "string", "applyToTenantId": "string"
{
}
UpdateOptions
CreateOptions
PatchOptions
CreateOrUpdateOptions
GetOptionMetadataByName
GET
/api/management/v1/OptionMetadata/type/{type}/ref/{refId}/name/{name}
Responses
OK
application/json
JSON "id": "string", "name": "string", "description": "string", "category": "string", "isMandatory": true, "defaultValue": "string", "optionType": "string", "optionTargetType": "string", "applyToIdpTypeId": "string", "applyToTwoFactorTypeId": "string"
{
}
GetOptionsMetadatas
GET
/api/management/v1/OptionMetadata/type/{type}/ref/{refId}
Responses
OK
application/json
JSON { "id": "string", "name": "string", "description": "string", "category": "string", "isMandatory": true, "defaultValue": "string", "optionType": "string", "optionTargetType": "string", "applyToIdpTypeId": "string", "applyToTwoFactorTypeId": "string" }
[
]
GetOptionMetadata
GET
/api/management/v1/OptionMetadata/{id}
Responses
OK
application/json
JSON "id": "string", "name": "string", "description": "string", "category": "string", "isMandatory": true, "defaultValue": "string", "optionType": "string", "optionTargetType": "string", "applyToIdpTypeId": "string", "applyToTwoFactorTypeId": "string"
{
}
GetOptionMetadatas
GET
/api/management/v1/OptionMetadata
Responses
OK
application/json
JSON { "id": "string", "name": "string", "description": "string", "category": "string", "isMandatory": true, "defaultValue": "string", "optionType": "string", "optionTargetType": "string", "applyToIdpTypeId": "string", "applyToTwoFactorTypeId": "string" }
[
]
GetProductInformation
GET
/api/management/v1/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" }
{
}
Subscription
Operations
GET/api/management/v1/SubscriptionPOST/api/management/v1/SubscriptionPOST/api/management/v1/Subscription/createorupdateGET/api/management/v1/Subscription/{id}PUT/api/management/v1/Subscription/{id}DELETE/api/management/v1/Subscription/{id}PATCH/api/management/v1/Subscription/{id}PUT/api/management/v1/Subscription/batchPOST/api/management/v1/Subscription/batchDELETE/api/management/v1/Subscription/batchPATCH/api/management/v1/Subscription/batchPOST/api/management/v1/Subscription/createorupdate/batch
GetSubscriptions
GET
/api/management/v1/Subscription
Responses
OK
application/json
JSON { "id": "string", "name": "string", "status": "string", "customerId": "string" }
[
]
CreateSubscription
CreateOrUpdateSubscription
GetSubscription
GET
/api/management/v1/Subscription/{id}
Responses
OK
application/json
JSON "id": "string", "name": "string", "status": "string", "customerId": "string"
{
}
UpdateSubscription
PatchSubscription
UpdateSubscriptions
CreateSubscriptions
DeleteSubscriptions
PatchSubscriptions
CreateOrUpdateSubscriptions
Tenant
Operations
GET/api/management/v1/TenantPOST/api/management/v1/TenantPOST/api/management/v1/Tenant/createorupdateGET/api/management/v1/Tenant/{id}PUT/api/management/v1/Tenant/{id}DELETE/api/management/v1/Tenant/{id}PATCH/api/management/v1/Tenant/{id}PUT/api/management/v1/Tenant/batchPOST/api/management/v1/Tenant/batchDELETE/api/management/v1/Tenant/batchPATCH/api/management/v1/Tenant/batchPOST/api/management/v1/Tenant/createorupdate/batch
GetTenants
GET
/api/management/v1/Tenant
Responses
OK
application/json
JSON { "id": "string", "name": "string", "accessGrantConsent": "string", "logoutConsent": "string", "tenantKey": "string", "hasConfigurationError": true, "subscriptionId": "string", "options": [...], "ipAddressRanges": [...], "idpInstances": "[Circular Reference]", "twoFactorInstances": "[Circular Reference]", "clientApps": "[Circular Reference]" }
[
]
CreateTenant
POST
/api/management/v1/Tenant
Request Body
JSON "id": "string", "name": "string", "accessGrantConsent": "string", "logoutConsent": "string", "tenantKey": "string", "hasConfigurationError": true, "subscriptionId": "string", "options": [ ], "ipAddressRanges": [ {...} ], "idpInstances": "[Circular Reference]", "twoFactorInstances": "[Circular Reference]", "clientApps": "[Circular Reference]"
{
}
Responses
Created
application/json
JSON "id": "string", "name": "string", "accessGrantConsent": "string", "logoutConsent": "string", "tenantKey": "string", "hasConfigurationError": true, "subscriptionId": "string", "options": [ ], "ipAddressRanges": [ {...} ], "idpInstances": "[Circular Reference]", "twoFactorInstances": "[Circular Reference]", "clientApps": "[Circular Reference]"
{
}
CreateOrUpdateTenant
POST
/api/management/v1/Tenant/createorupdate
Request Body
JSON "id": "string", "name": "string", "accessGrantConsent": "string", "logoutConsent": "string", "tenantKey": "string", "hasConfigurationError": true, "subscriptionId": "string", "options": [ ], "ipAddressRanges": [ {...} ], "idpInstances": "[Circular Reference]", "twoFactorInstances": "[Circular Reference]", "clientApps": "[Circular Reference]"
{
}
Responses
Created
application/json
JSON "id": "string", "name": "string", "accessGrantConsent": "string", "logoutConsent": "string", "tenantKey": "string", "hasConfigurationError": true, "subscriptionId": "string", "options": [ ], "ipAddressRanges": [ {...} ], "idpInstances": "[Circular Reference]", "twoFactorInstances": "[Circular Reference]", "clientApps": "[Circular Reference]"
{
}
GetTenant
GET
/api/management/v1/Tenant/{id}
Responses
OK
application/json
JSON "id": "string", "name": "string", "accessGrantConsent": "string", "logoutConsent": "string", "tenantKey": "string", "hasConfigurationError": true, "subscriptionId": "string", "options": [ ], "ipAddressRanges": [ {...} ], "idpInstances": "[Circular Reference]", "twoFactorInstances": "[Circular Reference]", "clientApps": "[Circular Reference]"
{
}
UpdateTenant
PUT
/api/management/v1/Tenant/{id}
Request Body
JSON "id": "string", "name": "string", "accessGrantConsent": "string", "logoutConsent": "string", "tenantKey": "string", "hasConfigurationError": true, "subscriptionId": "string", "options": [ ], "ipAddressRanges": [ {...} ], "idpInstances": "[Circular Reference]", "twoFactorInstances": "[Circular Reference]", "clientApps": "[Circular Reference]"
{
}
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "accessGrantConsent": "string", "logoutConsent": "string", "tenantKey": "string", "hasConfigurationError": true, "subscriptionId": "string", "options": [ ], "ipAddressRanges": [ {...} ], "idpInstances": "[Circular Reference]", "twoFactorInstances": "[Circular Reference]", "clientApps": "[Circular Reference]"
{
}
PatchTenant
PATCH
/api/management/v1/Tenant/{id}
Request Body
JSON { "op": "string", "path": "string", "from": "string", "value": null }
[
]
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "accessGrantConsent": "string", "logoutConsent": "string", "tenantKey": "string", "hasConfigurationError": true, "subscriptionId": "string", "options": [ ], "ipAddressRanges": [ {...} ], "idpInstances": "[Circular Reference]", "twoFactorInstances": "[Circular Reference]", "clientApps": "[Circular Reference]"
{
}
UpdateTenants
CreateTenants
PatchTenants
PATCH
/api/management/v1/Tenant/batch
Request Body
JSON
[
]
Responses
Accepted
application/json
JSON { "id": "string", "name": "string", "accessGrantConsent": "string", "logoutConsent": "string", "tenantKey": "string", "hasConfigurationError": true, "subscriptionId": "string", "options": [...], "ipAddressRanges": [...], "idpInstances": "[Circular Reference]", "twoFactorInstances": "[Circular Reference]", "clientApps": "[Circular Reference]" }
[
]
CreateOrUpdateTenants
TwoFactorInstance
Operations
GET/api/management/v1/TwoFactorInstancePOST/api/management/v1/TwoFactorInstancePOST/api/management/v1/TwoFactorInstance/createorupdateGET/api/management/v1/TwoFactorInstance/{id}PUT/api/management/v1/TwoFactorInstance/{id}DELETE/api/management/v1/TwoFactorInstance/{id}PATCH/api/management/v1/TwoFactorInstance/{id}PUT/api/management/v1/TwoFactorInstance/batchPOST/api/management/v1/TwoFactorInstance/batchDELETE/api/management/v1/TwoFactorInstance/batchPATCH/api/management/v1/TwoFactorInstance/batchPOST/api/management/v1/TwoFactorInstance/createorupdate/batch
GetTwoFactorInstances
GET
/api/management/v1/TwoFactorInstance
Responses
OK
application/json
JSON { "id": "string", "name": "string", "executionOrder": 0, "isActive": true, "hasConfigurationError": true, "twoFactorTypeId": "string", "subscriptionId": "string", "clientApps": [...], "tenants": [...], "idpInstances": "[Circular Reference]", "idpTypes": [...], "proAuthUsers": [...], "options": [...], "metadata": [...] }
[
]
CreateTwoFactorInstance
POST
/api/management/v1/TwoFactorInstance
Request Body
JSON "id": "string", "name": "string", "executionOrder": 0, "isActive": true, "hasConfigurationError": true, "twoFactorTypeId": "string", "subscriptionId": "string", "clientApps": [ {...} ], "tenants": [ ], "idpInstances": "[Circular Reference]", "idpTypes": [ {...} ], "proAuthUsers": [ ], "options": [ ], "metadata": [ {...} ]
{
}
Responses
Created
application/json
JSON "id": "string", "name": "string", "executionOrder": 0, "isActive": true, "hasConfigurationError": true, "twoFactorTypeId": "string", "subscriptionId": "string", "clientApps": [ {...} ], "tenants": [ ], "idpInstances": "[Circular Reference]", "idpTypes": [ {...} ], "proAuthUsers": [ ], "options": [ ], "metadata": [ {...} ]
{
}
CreateOrUpdateTwoFactorInstance
POST
/api/management/v1/TwoFactorInstance/createorupdate
Request Body
JSON "id": "string", "name": "string", "executionOrder": 0, "isActive": true, "hasConfigurationError": true, "twoFactorTypeId": "string", "subscriptionId": "string", "clientApps": [ {...} ], "tenants": [ ], "idpInstances": "[Circular Reference]", "idpTypes": [ {...} ], "proAuthUsers": [ ], "options": [ ], "metadata": [ {...} ]
{
}
Responses
Created
application/json
JSON "id": "string", "name": "string", "executionOrder": 0, "isActive": true, "hasConfigurationError": true, "twoFactorTypeId": "string", "subscriptionId": "string", "clientApps": [ {...} ], "tenants": [ ], "idpInstances": "[Circular Reference]", "idpTypes": [ {...} ], "proAuthUsers": [ ], "options": [ ], "metadata": [ {...} ]
{
}
GetTwoFactorInstance
GET
/api/management/v1/TwoFactorInstance/{id}
Responses
OK
application/json
JSON "id": "string", "name": "string", "executionOrder": 0, "isActive": true, "hasConfigurationError": true, "twoFactorTypeId": "string", "subscriptionId": "string", "clientApps": [ {...} ], "tenants": [ ], "idpInstances": "[Circular Reference]", "idpTypes": [ {...} ], "proAuthUsers": [ ], "options": [ ], "metadata": [ {...} ]
{
}
UpdateTwoFactorInstance
PUT
/api/management/v1/TwoFactorInstance/{id}
Request Body
JSON "id": "string", "name": "string", "executionOrder": 0, "isActive": true, "hasConfigurationError": true, "twoFactorTypeId": "string", "subscriptionId": "string", "clientApps": [ {...} ], "tenants": [ ], "idpInstances": "[Circular Reference]", "idpTypes": [ {...} ], "proAuthUsers": [ ], "options": [ ], "metadata": [ {...} ]
{
}
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "executionOrder": 0, "isActive": true, "hasConfigurationError": true, "twoFactorTypeId": "string", "subscriptionId": "string", "clientApps": [ {...} ], "tenants": [ ], "idpInstances": "[Circular Reference]", "idpTypes": [ {...} ], "proAuthUsers": [ ], "options": [ ], "metadata": [ {...} ]
{
}
PatchTwoFactorInstance
PATCH
/api/management/v1/TwoFactorInstance/{id}
Request Body
JSON { "op": "string", "path": "string", "from": "string", "value": null }
[
]
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "executionOrder": 0, "isActive": true, "hasConfigurationError": true, "twoFactorTypeId": "string", "subscriptionId": "string", "clientApps": [ {...} ], "tenants": [ ], "idpInstances": "[Circular Reference]", "idpTypes": [ {...} ], "proAuthUsers": [ ], "options": [ ], "metadata": [ {...} ]
{
}
UpdateTwoFactorInstances
CreateTwoFactorInstances
DeleteTwoFactorInstances
PatchTwoFactorInstances
PATCH
/api/management/v1/TwoFactorInstance/batch
Request Body
JSON
[
]
Responses
Accepted
application/json
JSON { "id": "string", "name": "string", "executionOrder": 0, "isActive": true, "hasConfigurationError": true, "twoFactorTypeId": "string", "subscriptionId": "string", "clientApps": [...], "tenants": [...], "idpInstances": "[Circular Reference]", "idpTypes": [...], "proAuthUsers": [...], "options": [...], "metadata": [...] }
[
]
CreateOrUpdateTwoFactorInstances
TwoFactorInstanceMetadata
Operations
GET/api/management/v1/TwoFactorInstance/{twoFactorInstanceId}/TwoFactorInstanceMetadata/twoFactorInstanceIdGET/api/management/v1/TwoFactorInstance/{twoFactorInstanceId}/TwoFactorInstanceMetadata/{key}PUT/api/management/v1/TwoFactorInstance/{twoFactorInstanceId}/TwoFactorInstanceMetadata/{key}DELETE/api/management/v1/TwoFactorInstance/{twoFactorInstanceId}/TwoFactorInstanceMetadata/{key}PATCH/api/management/v1/TwoFactorInstance/{twoFactorInstanceId}/TwoFactorInstanceMetadata/{key}PUT/api/management/v1/TwoFactorInstance/{twoFactorInstanceId}/TwoFactorInstanceMetadata/batchPOST/api/management/v1/TwoFactorInstance/{twoFactorInstanceId}/TwoFactorInstanceMetadata/batchDELETE/api/management/v1/TwoFactorInstance/{twoFactorInstanceId}/TwoFactorInstanceMetadata/batchPATCH/api/management/v1/TwoFactorInstance/{twoFactorInstanceId}/TwoFactorInstanceMetadata/batchGET/api/management/v1/TwoFactorInstance/{twoFactorInstanceId}/TwoFactorInstanceMetadataPOST/api/management/v1/TwoFactorInstance/{twoFactorInstanceId}/TwoFactorInstanceMetadataPOST/api/management/v1/TwoFactorInstance/{twoFactorInstanceId}/TwoFactorInstanceMetadata/createorupdatePOST/api/management/v1/TwoFactorInstance/{twoFactorInstanceId}/TwoFactorInstanceMetadata/createorupdate/batch
GetTwoFactorInstanceMetadataByTwoFactorInstanceId
GET
/api/management/v1/TwoFactorInstance/{twoFactorInstanceId}/TwoFactorInstanceMetadata/twoFactorInstanceId
Responses
OK
application/json
JSON { "twoFactorInstanceId": "string", "key": "string", "value": "string" }
[
]
GetTwoFactorInstanceMetadata
GET
/api/management/v1/TwoFactorInstance/{twoFactorInstanceId}/TwoFactorInstanceMetadata/{key}
Responses
OK
application/json
JSON "twoFactorInstanceId": "string", "key": "string", "value": "string"
{
}
UpdateTwoFactorInstanceMetadata
DeleteTwoFactorInstanceMetadata
DELETE
/api/management/v1/TwoFactorInstance/{twoFactorInstanceId}/TwoFactorInstanceMetadata/{key}
Responses
No Content
PatchTwoFactorInstanceMetadata
UpdateTwoFactorInstanceMetadatas
CreateTwoFactorInstanceMetadatas
DeleteTwoFactorInstanceMetadatas
PatchTwoFactorInstanceMetadatas
GetTwoFactorInstanceMetadatas
GET
/api/management/v1/TwoFactorInstance/{twoFactorInstanceId}/TwoFactorInstanceMetadata
Responses
OK
application/json
JSON
[
]
CreateTwoFactorInstanceMetadata
CreateOrUpdateTwoFactorInstanceMetadata
CreateOrUpdateTwoFactorInstanceMetadatas
TwoFactorType
Operations
GET/api/management/v1/TwoFactorType/name/{name}GET/api/management/v1/TwoFactorTypePOST/api/management/v1/TwoFactorTypePUT/api/management/v1/TwoFactorType/batchPOST/api/management/v1/TwoFactorType/batchDELETE/api/management/v1/TwoFactorType/batchPATCH/api/management/v1/TwoFactorType/batchGET/api/management/v1/TwoFactorType/{id}PUT/api/management/v1/TwoFactorType/{id}DELETE/api/management/v1/TwoFactorType/{id}PATCH/api/management/v1/TwoFactorType/{id}POST/api/management/v1/TwoFactorType/createorupdatePOST/api/management/v1/TwoFactorType/createorupdate/batch
GetTwoFactorTypeByName
GET
/api/management/v1/TwoFactorType/name/{name}
Responses
OK
application/json
JSON "id": "string", "name": "string", "factoryType": "string", "isEnabled": true
{
}
GetTwoFactorTypes
GET
/api/management/v1/TwoFactorType
Responses
OK
application/json
JSON { "id": "string", "name": "string", "factoryType": "string", "isEnabled": true }
[
]
CreateTwoFactorType
UpdateTwoFactorTypes
CreateTwoFactorTypes
DeleteTwoFactorTypes
PatchTwoFactorTypes
GetTwoFactorType
GET
/api/management/v1/TwoFactorType/{id}
Responses
OK
application/json
JSON "id": "string", "name": "string", "factoryType": "string", "isEnabled": true
{
}
UpdateTwoFactorType
PatchTwoFactorType
CreateOrUpdateTwoFactorType
CreateOrUpdateTwoFactorTypes
GetApplicationGroupsByTenant
GET
/api/management/v1/ApplicationGroup/tenant/{tenantId}
Responses
OK
application/json
JSON { "id": "string", "name": "string" }
[
]
GetApplicationGroupsByIdpInstance
GET
/api/management/v1/ApplicationGroup/idpinstance/{idpInstanceId}
Responses
OK
application/json
JSON
[
]
GetApplicationGroup
GET
/api/management/v1/ApplicationGroup/{id}
Responses
OK
application/json
JSON "id": "string", "name": "string"
{
}
GetApplicationGroups
GET
/api/management/v1/ApplicationGroup
Responses
OK
application/json
JSON { "id": "string", "name": "string" }
[
]
ProAuthGroup
Operations
GET/api/management/v1/ProAuthGroup/idp/{idpId}/scim/{id}GET/api/management/v1/ProAuthGroup/idp/{idpId}/userstore/{id}GET/api/management/v1/ProAuthGroupPOST/api/management/v1/ProAuthGroupPOST/api/management/v1/ProAuthGroup/createorupdateGET/api/management/v1/ProAuthGroup/{id}PUT/api/management/v1/ProAuthGroup/{id}DELETE/api/management/v1/ProAuthGroup/{id}PATCH/api/management/v1/ProAuthGroup/{id}PUT/api/management/v1/ProAuthGroup/batchPOST/api/management/v1/ProAuthGroup/batchDELETE/api/management/v1/ProAuthGroup/batchPATCH/api/management/v1/ProAuthGroup/batchPOST/api/management/v1/ProAuthGroup/createorupdate/batch
GetScimSynchronizedProAuthGroupByScimId
GET
/api/management/v1/ProAuthGroup/idp/{idpId}/scim/{id}
Responses
OK
application/json
JSON "id": "string", "name": "string", "federatedExternalGroupId": "string", "scimSynchronized": true, "idpInstanceId": "string", "subscriptionId": "string", "applyToTenantId": "string", "proAuthGroupRoles": [ {...} ], "memberUsers": [ {...} ], "parentGroups": "[Circular Reference]", "memberGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "metadata": [ {...} ]
{
}
GetSynchronizedProAuthGroupByUserStoreId
GET
/api/management/v1/ProAuthGroup/idp/{idpId}/userstore/{id}
Responses
OK
application/json
JSON "id": "string", "name": "string", "federatedExternalGroupId": "string", "scimSynchronized": true, "idpInstanceId": "string", "subscriptionId": "string", "applyToTenantId": "string", "proAuthGroupRoles": [ {...} ], "memberUsers": [ {...} ], "parentGroups": "[Circular Reference]", "memberGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "metadata": [ {...} ]
{
}
GetProAuthGroups
GET
/api/management/v1/ProAuthGroup
Responses
OK
application/json
JSON { "id": "string", "name": "string", "federatedExternalGroupId": "string", "scimSynchronized": true, "idpInstanceId": "string", "subscriptionId": "string", "applyToTenantId": "string", "proAuthGroupRoles": [...], "memberUsers": [...], "parentGroups": "[Circular Reference]", "memberGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "metadata": [...] }
[
]
CreateProAuthGroup
POST
/api/management/v1/ProAuthGroup
Request Body
JSON "id": "string", "name": "string", "federatedExternalGroupId": "string", "scimSynchronized": true, "idpInstanceId": "string", "subscriptionId": "string", "applyToTenantId": "string", "proAuthGroupRoles": [ {...} ], "memberUsers": [ {...} ], "parentGroups": "[Circular Reference]", "memberGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "metadata": [ {...} ]
{
}
Responses
Created
application/json
JSON "id": "string", "name": "string", "federatedExternalGroupId": "string", "scimSynchronized": true, "idpInstanceId": "string", "subscriptionId": "string", "applyToTenantId": "string", "proAuthGroupRoles": [ {...} ], "memberUsers": [ {...} ], "parentGroups": "[Circular Reference]", "memberGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "metadata": [ {...} ]
{
}
CreateOrUpdateProAuthGroup
POST
/api/management/v1/ProAuthGroup/createorupdate
Request Body
JSON "id": "string", "name": "string", "federatedExternalGroupId": "string", "scimSynchronized": true, "idpInstanceId": "string", "subscriptionId": "string", "applyToTenantId": "string", "proAuthGroupRoles": [ {...} ], "memberUsers": [ {...} ], "parentGroups": "[Circular Reference]", "memberGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "metadata": [ {...} ]
{
}
Responses
Created
application/json
JSON "id": "string", "name": "string", "federatedExternalGroupId": "string", "scimSynchronized": true, "idpInstanceId": "string", "subscriptionId": "string", "applyToTenantId": "string", "proAuthGroupRoles": [ {...} ], "memberUsers": [ {...} ], "parentGroups": "[Circular Reference]", "memberGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "metadata": [ {...} ]
{
}
GetProAuthGroup
GET
/api/management/v1/ProAuthGroup/{id}
Responses
OK
application/json
JSON "id": "string", "name": "string", "federatedExternalGroupId": "string", "scimSynchronized": true, "idpInstanceId": "string", "subscriptionId": "string", "applyToTenantId": "string", "proAuthGroupRoles": [ {...} ], "memberUsers": [ {...} ], "parentGroups": "[Circular Reference]", "memberGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "metadata": [ {...} ]
{
}
UpdateProAuthGroup
PUT
/api/management/v1/ProAuthGroup/{id}
Request Body
JSON "id": "string", "name": "string", "federatedExternalGroupId": "string", "scimSynchronized": true, "idpInstanceId": "string", "subscriptionId": "string", "applyToTenantId": "string", "proAuthGroupRoles": [ {...} ], "memberUsers": [ {...} ], "parentGroups": "[Circular Reference]", "memberGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "metadata": [ {...} ]
{
}
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "federatedExternalGroupId": "string", "scimSynchronized": true, "idpInstanceId": "string", "subscriptionId": "string", "applyToTenantId": "string", "proAuthGroupRoles": [ {...} ], "memberUsers": [ {...} ], "parentGroups": "[Circular Reference]", "memberGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "metadata": [ {...} ]
{
}
PatchProAuthGroup
PATCH
/api/management/v1/ProAuthGroup/{id}
Request Body
JSON { "op": "string", "path": "string", "from": "string", "value": null }
[
]
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "federatedExternalGroupId": "string", "scimSynchronized": true, "idpInstanceId": "string", "subscriptionId": "string", "applyToTenantId": "string", "proAuthGroupRoles": [ {...} ], "memberUsers": [ {...} ], "parentGroups": "[Circular Reference]", "memberGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "metadata": [ {...} ]
{
}
UpdateProAuthGroups
CreateProAuthGroups
DeleteProAuthGroups
PatchProAuthGroups
PATCH
/api/management/v1/ProAuthGroup/batch
Request Body
JSON
[
]
Responses
Accepted
application/json
JSON { "id": "string", "name": "string", "federatedExternalGroupId": "string", "scimSynchronized": true, "idpInstanceId": "string", "subscriptionId": "string", "applyToTenantId": "string", "proAuthGroupRoles": [...], "memberUsers": [...], "parentGroups": "[Circular Reference]", "memberGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "metadata": [...] }
[
]
CreateOrUpdateProAuthGroups
ProAuthGroupMetadata
Operations
GET/api/management/v1/ProAuthGroup/{proAuthGroupId}/ProAuthGroupMetadata/proAuthGroupIdGET/api/management/v1/ProAuthGroup/{proAuthGroupId}/ProAuthGroupMetadata/{key}PUT/api/management/v1/ProAuthGroup/{proAuthGroupId}/ProAuthGroupMetadata/{key}DELETE/api/management/v1/ProAuthGroup/{proAuthGroupId}/ProAuthGroupMetadata/{key}PATCH/api/management/v1/ProAuthGroup/{proAuthGroupId}/ProAuthGroupMetadata/{key}PUT/api/management/v1/ProAuthGroup/{proAuthGroupId}/ProAuthGroupMetadata/batchPOST/api/management/v1/ProAuthGroup/{proAuthGroupId}/ProAuthGroupMetadata/batchDELETE/api/management/v1/ProAuthGroup/{proAuthGroupId}/ProAuthGroupMetadata/batchPATCH/api/management/v1/ProAuthGroup/{proAuthGroupId}/ProAuthGroupMetadata/batchGET/api/management/v1/ProAuthGroup/{proAuthGroupId}/ProAuthGroupMetadataPOST/api/management/v1/ProAuthGroup/{proAuthGroupId}/ProAuthGroupMetadataPOST/api/management/v1/ProAuthGroup/{proAuthGroupId}/ProAuthGroupMetadata/createorupdatePOST/api/management/v1/ProAuthGroup/{proAuthGroupId}/ProAuthGroupMetadata/createorupdate/batch
GetProAuthGroupMetadataByProAuthGroupId
GET
/api/management/v1/ProAuthGroup/{proAuthGroupId}/ProAuthGroupMetadata/proAuthGroupId
Responses
OK
application/json
JSON { "proAuthGroupId": "string", "key": "string", "value": "string" }
[
]
GetProAuthGroupMetadata
GET
/api/management/v1/ProAuthGroup/{proAuthGroupId}/ProAuthGroupMetadata/{key}
Responses
OK
application/json
JSON "proAuthGroupId": "string", "key": "string", "value": "string"
{
}
UpdateProAuthGroupMetadata
DeleteProAuthGroupMetadata
DELETE
/api/management/v1/ProAuthGroup/{proAuthGroupId}/ProAuthGroupMetadata/{key}
Responses
No Content
PatchProAuthGroupMetadata
UpdateProAuthGroupMetadatas
CreateProAuthGroupMetadatas
DeleteProAuthGroupMetadatas
PatchProAuthGroupMetadatas
GetProAuthGroupMetadatas
GET
/api/management/v1/ProAuthGroup/{proAuthGroupId}/ProAuthGroupMetadata
Responses
OK
application/json
JSON
[
]
CreateProAuthGroupMetadata
CreateOrUpdateProAuthGroupMetadata
CreateOrUpdateProAuthGroupMetadatas
ProAuthGroupRole
Operations
GET/api/management/v1/ProAuthGroup/ProAuthGroupRole/proauthgroup/{proAuthGroupId}GET/api/management/v1/ProAuthGroup/ProAuthGroupRolePOST/api/management/v1/ProAuthGroup/ProAuthGroupRolePOST/api/management/v1/ProAuthGroup/ProAuthGroupRole/createorupdateGET/api/management/v1/ProAuthGroup/ProAuthGroupRole/{id}PUT/api/management/v1/ProAuthGroup/ProAuthGroupRole/{id}DELETE/api/management/v1/ProAuthGroup/ProAuthGroupRole/{id}PATCH/api/management/v1/ProAuthGroup/ProAuthGroupRole/{id}PUT/api/management/v1/ProAuthGroup/ProAuthGroupRole/batchPOST/api/management/v1/ProAuthGroup/ProAuthGroupRole/batchDELETE/api/management/v1/ProAuthGroup/ProAuthGroupRole/batchPATCH/api/management/v1/ProAuthGroup/ProAuthGroupRole/batchPOST/api/management/v1/ProAuthGroup/ProAuthGroupRole/createorupdate/batch
GetProAuthGroupRolesByGroup
GET
/api/management/v1/ProAuthGroup/ProAuthGroupRole/proauthgroup/{proAuthGroupId}
Responses
OK
application/json
JSON { "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "proAuthGroupId": "string" }
[
]
GetProAuthGroupRoles
GET
/api/management/v1/ProAuthGroup/ProAuthGroupRole
Responses
OK
application/json
JSON { "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "proAuthGroupId": "string" }
[
]
CreateProAuthGroupRole
POST
/api/management/v1/ProAuthGroup/ProAuthGroupRole
Request Body
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "proAuthGroupId": "string"
{
}
Responses
Created
application/json
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "proAuthGroupId": "string"
{
}
CreateOrUpdateProAuthGroupRole
POST
/api/management/v1/ProAuthGroup/ProAuthGroupRole/createorupdate
Request Body
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "proAuthGroupId": "string"
{
}
Responses
Created
application/json
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "proAuthGroupId": "string"
{
}
GetProAuthGroupRole
GET
/api/management/v1/ProAuthGroup/ProAuthGroupRole/{id}
Responses
OK
application/json
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "proAuthGroupId": "string"
{
}
UpdateProAuthGroupRole
PUT
/api/management/v1/ProAuthGroup/ProAuthGroupRole/{id}
Request Body
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "proAuthGroupId": "string"
{
}
Responses
Accepted
application/json
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "proAuthGroupId": "string"
{
}
DeleteProAuthGroupRole
DELETE
/api/management/v1/ProAuthGroup/ProAuthGroupRole/{id}
Responses
No Content
PatchProAuthGroupRole
PATCH
/api/management/v1/ProAuthGroup/ProAuthGroupRole/{id}
Request Body
JSON { "op": "string", "path": "string", "from": "string", "value": null }
[
]
Responses
Accepted
application/json
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "proAuthGroupId": "string"
{
}
UpdateProAuthGroupRoles
CreateProAuthGroupRoles
DeleteProAuthGroupRoles
PatchProAuthGroupRoles
CreateOrUpdateProAuthGroupRoles
ClientAppFederatedConfiguration
Operations
GET/api/management/v1/ClientApp/ClientAppFederatedConfiguration/clientapp/{clientAppId}GET/api/management/v1/ClientApp/ClientAppFederatedConfigurationPOST/api/management/v1/ClientApp/ClientAppFederatedConfigurationPOST/api/management/v1/ClientApp/ClientAppFederatedConfiguration/createorupdateGET/api/management/v1/ClientApp/ClientAppFederatedConfiguration/{id}PUT/api/management/v1/ClientApp/ClientAppFederatedConfiguration/{id}DELETE/api/management/v1/ClientApp/ClientAppFederatedConfiguration/{id}PATCH/api/management/v1/ClientApp/ClientAppFederatedConfiguration/{id}PUT/api/management/v1/ClientApp/ClientAppFederatedConfiguration/batchPOST/api/management/v1/ClientApp/ClientAppFederatedConfiguration/batchDELETE/api/management/v1/ClientApp/ClientAppFederatedConfiguration/batchPATCH/api/management/v1/ClientApp/ClientAppFederatedConfiguration/batchPOST/api/management/v1/ClientApp/ClientAppFederatedConfiguration/createorupdate/batch
GetClientAppFederatedConfigurationsByClientAppId
GET
/api/management/v1/ClientApp/ClientAppFederatedConfiguration/clientapp/{clientAppId}
Responses
OK
application/json
JSON { "id": "string", "issuer": "string", "subject": "string", "clientAppId": "string" }
[
]
GetClientAppFederatedConfigurations
GET
/api/management/v1/ClientApp/ClientAppFederatedConfiguration
Responses
OK
application/json
JSON
[
]
CreateClientAppFederatedConfiguration
CreateOrUpdateClientAppFederatedConfiguration
POST
/api/management/v1/ClientApp/ClientAppFederatedConfiguration/createorupdate
Request Body
JSON "id": "string", "issuer": "string", "subject": "string", "clientAppId": "string"
{
}
Responses
Created
application/json
JSON "id": "string", "issuer": "string", "subject": "string", "clientAppId": "string"
{
}
GetClientAppFederatedConfiguration
GET
/api/management/v1/ClientApp/ClientAppFederatedConfiguration/{id}
Responses
OK
application/json
JSON "id": "string", "issuer": "string", "subject": "string", "clientAppId": "string"
{
}
UpdateClientAppFederatedConfiguration
DeleteClientAppFederatedConfiguration
DELETE
/api/management/v1/ClientApp/ClientAppFederatedConfiguration/{id}
Responses
No Content
PatchClientAppFederatedConfiguration
UpdateClientAppFederatedConfigurations
CreateClientAppFederatedConfigurations
DeleteClientAppFederatedConfigurations
PatchClientAppFederatedConfigurations
CreateOrUpdateClientAppFederatedConfigurations
ClientAppSecret
Operations
GET/api/management/v1/ClientApp/ClientAppSecret/clientapp/{clientAppId}GET/api/management/v1/ClientApp/ClientAppSecretPOST/api/management/v1/ClientApp/ClientAppSecretPOST/api/management/v1/ClientApp/ClientAppSecret/createorupdateGET/api/management/v1/ClientApp/ClientAppSecret/{id}PUT/api/management/v1/ClientApp/ClientAppSecret/{id}DELETE/api/management/v1/ClientApp/ClientAppSecret/{id}PATCH/api/management/v1/ClientApp/ClientAppSecret/{id}PUT/api/management/v1/ClientApp/ClientAppSecret/batchPOST/api/management/v1/ClientApp/ClientAppSecret/batchDELETE/api/management/v1/ClientApp/ClientAppSecret/batchPATCH/api/management/v1/ClientApp/ClientAppSecret/batchPOST/api/management/v1/ClientApp/ClientAppSecret/createorupdate/batch
GetClientAppSecretsByClientAppId
GET
/api/management/v1/ClientApp/ClientAppSecret/clientapp/{clientAppId}
Responses
OK
application/json
JSON { "id": "string", "name": "string", "secret": "string", "expiry": "string", "clientAppId": "string" }
[
]
GetClientAppSecrets
GET
/api/management/v1/ClientApp/ClientAppSecret
Responses
OK
application/json
JSON
[
]
CreateClientAppSecret
POST
/api/management/v1/ClientApp/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"
{
}
CreateOrUpdateClientAppSecret
POST
/api/management/v1/ClientApp/ClientAppSecret/createorupdate
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"
{
}
GetClientAppSecret
GET
/api/management/v1/ClientApp/ClientAppSecret/{id}
Responses
OK
application/json
JSON "id": "string", "name": "string", "secret": "string", "expiry": "string", "clientAppId": "string"
{
}
UpdateClientAppSecret
PUT
/api/management/v1/ClientApp/ClientAppSecret/{id}
Request Body
JSON "id": "string", "name": "string", "secret": "string", "expiry": "string", "clientAppId": "string"
{
}
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "secret": "string", "expiry": "string", "clientAppId": "string"
{
}
PatchClientAppSecret
UpdateClientAppSecrets
CreateClientAppSecrets
DeleteClientAppSecrets
PatchClientAppSecrets
CreateOrUpdateClientAppSecrets
GetApplicationUsersByTenant
GET
/api/management/v1/ApplicationUser/tenant/{tenantId}
Responses
OK
application/json
JSON { "id": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "organizationalUnit": "string", "managerId": "string", "manager": null }
[
]
GetApplicationUsersByIdpInstance
GET
/api/management/v1/ApplicationUser/idpinstance/{idpInstanceId}
Responses
OK
application/json
JSON
[
]
GetApplicationUser
GET
/api/management/v1/ApplicationUser/{id}
Responses
OK
application/json
JSON "id": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "organizationalUnit": "string", "managerId": "string", "manager": null
{
}
GetApplicationUsers
GET
/api/management/v1/ApplicationUser
Responses
OK
application/json
JSON { "id": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "organizationalUnit": "string", "managerId": "string", "manager": null }
[
]
ProAuthUser
Operations
GET/api/management/v1/ProAuthUserPOST/api/management/v1/ProAuthUserPUT/api/management/v1/ProAuthUser/batchPOST/api/management/v1/ProAuthUser/batchDELETE/api/management/v1/ProAuthUser/batchPATCH/api/management/v1/ProAuthUser/batchGET/api/management/v1/ProAuthUser/{id}PUT/api/management/v1/ProAuthUser/{id}DELETE/api/management/v1/ProAuthUser/{id}PATCH/api/management/v1/ProAuthUser/{id}POST/api/management/v1/ProAuthUser/createorupdatePOST/api/management/v1/ProAuthUser/createorupdate/batchDELETE/api/management/v1/ProAuthUser/all/tenant/{tenantId}DELETE/api/management/v1/ProAuthUser/all/idpInstance/{idpInstanceId}DELETE/api/management/v1/ProAuthUser/all/subscription/{subscriptionId}DELETE/api/management/v1/ProAuthUser/all/subscription/{subscriptionId}/noidpGET/api/management/v1/ProAuthUser/idp/{idpId}/externaluniqueuser/{id}GET/api/management/v1/ProAuthUser/idp/{idpId}/scim/{id}GET/api/management/v1/ProAuthUser/idp/{idpId}/userstore/{id}POST/api/management/v1/ProAuthUser/requestuserdetails/{id}GET/api/management/v1/ProAuthUser/idp/{idpId}
GetProAuthUsers
GET
/api/management/v1/ProAuthUser
Responses
OK
application/json
JSON { "id": "string", "isUserActive": true, "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "organizationalUnit": "string", "requestUserDetailsOnNextLogin": true, "scimSynchronized": true, "invitationPending": true, "managerId": "string", "idpInstanceId": "string", "subscriptionId": "string", "twoFactorInstances": "[Circular Reference]", "memberOfGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "proAuthUserProfiles": [...], "proAuthUserFederatedIdentities": [...] }
[
]
CreateProAuthUser
POST
/api/management/v1/ProAuthUser
Request Body
JSON "id": "string", "isUserActive": true, "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "organizationalUnit": "string", "requestUserDetailsOnNextLogin": true, "scimSynchronized": true, "invitationPending": true, "managerId": "string", "idpInstanceId": "string", "subscriptionId": "string", "twoFactorInstances": "[Circular Reference]", "memberOfGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "proAuthUserProfiles": [ {...} ], "proAuthUserFederatedIdentities": [ {...} ]
{
}
Responses
Created
application/json
JSON "id": "string", "isUserActive": true, "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "organizationalUnit": "string", "requestUserDetailsOnNextLogin": true, "scimSynchronized": true, "invitationPending": true, "managerId": "string", "idpInstanceId": "string", "subscriptionId": "string", "twoFactorInstances": "[Circular Reference]", "memberOfGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "proAuthUserProfiles": [ {...} ], "proAuthUserFederatedIdentities": [ {...} ]
{
}
UpdateProAuthUsers
CreateProAuthUsers
DeleteProAuthUsers
PatchProAuthUsers
PATCH
/api/management/v1/ProAuthUser/batch
Request Body
JSON
[
]
Responses
Accepted
application/json
JSON { "id": "string", "isUserActive": true, "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "organizationalUnit": "string", "requestUserDetailsOnNextLogin": true, "scimSynchronized": true, "invitationPending": true, "managerId": "string", "idpInstanceId": "string", "subscriptionId": "string", "twoFactorInstances": "[Circular Reference]", "memberOfGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "proAuthUserProfiles": [...], "proAuthUserFederatedIdentities": [...] }
[
]
GetProAuthUser
GET
/api/management/v1/ProAuthUser/{id}
Responses
OK
application/json
JSON "id": "string", "isUserActive": true, "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "organizationalUnit": "string", "requestUserDetailsOnNextLogin": true, "scimSynchronized": true, "invitationPending": true, "managerId": "string", "idpInstanceId": "string", "subscriptionId": "string", "twoFactorInstances": "[Circular Reference]", "memberOfGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "proAuthUserProfiles": [ {...} ], "proAuthUserFederatedIdentities": [ {...} ]
{
}
UpdateProAuthUser
PUT
/api/management/v1/ProAuthUser/{id}
Request Body
JSON "id": "string", "isUserActive": true, "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "organizationalUnit": "string", "requestUserDetailsOnNextLogin": true, "scimSynchronized": true, "invitationPending": true, "managerId": "string", "idpInstanceId": "string", "subscriptionId": "string", "twoFactorInstances": "[Circular Reference]", "memberOfGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "proAuthUserProfiles": [ {...} ], "proAuthUserFederatedIdentities": [ {...} ]
{
}
Responses
Accepted
application/json
JSON "id": "string", "isUserActive": true, "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "organizationalUnit": "string", "requestUserDetailsOnNextLogin": true, "scimSynchronized": true, "invitationPending": true, "managerId": "string", "idpInstanceId": "string", "subscriptionId": "string", "twoFactorInstances": "[Circular Reference]", "memberOfGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "proAuthUserProfiles": [ {...} ], "proAuthUserFederatedIdentities": [ {...} ]
{
}
PatchProAuthUser
PATCH
/api/management/v1/ProAuthUser/{id}
Request Body
JSON { "op": "string", "path": "string", "from": "string", "value": null }
[
]
Responses
Accepted
application/json
JSON "id": "string", "isUserActive": true, "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "organizationalUnit": "string", "requestUserDetailsOnNextLogin": true, "scimSynchronized": true, "invitationPending": true, "managerId": "string", "idpInstanceId": "string", "subscriptionId": "string", "twoFactorInstances": "[Circular Reference]", "memberOfGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "proAuthUserProfiles": [ {...} ], "proAuthUserFederatedIdentities": [ {...} ]
{
}
CreateOrUpdateProAuthUser
POST
/api/management/v1/ProAuthUser/createorupdate
Request Body
JSON "id": "string", "isUserActive": true, "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "organizationalUnit": "string", "requestUserDetailsOnNextLogin": true, "scimSynchronized": true, "invitationPending": true, "managerId": "string", "idpInstanceId": "string", "subscriptionId": "string", "twoFactorInstances": "[Circular Reference]", "memberOfGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "proAuthUserProfiles": [ {...} ], "proAuthUserFederatedIdentities": [ {...} ]
{
}
Responses
Created
application/json
JSON "id": "string", "isUserActive": true, "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "organizationalUnit": "string", "requestUserDetailsOnNextLogin": true, "scimSynchronized": true, "invitationPending": true, "managerId": "string", "idpInstanceId": "string", "subscriptionId": "string", "twoFactorInstances": "[Circular Reference]", "memberOfGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "proAuthUserProfiles": [ {...} ], "proAuthUserFederatedIdentities": [ {...} ]
{
}
CreateOrUpdateProAuthUsers
DeleteAllProAuthUsersByTenant
DELETE
/api/management/v1/ProAuthUser/all/tenant/{tenantId}
Responses
No Content
DeleteAllProAuthUsersByIdp
DELETE
/api/management/v1/ProAuthUser/all/idpInstance/{idpInstanceId}
Responses
No Content
DeleteAllProAuthUsersBySubscription
DELETE
/api/management/v1/ProAuthUser/all/subscription/{subscriptionId}
Responses
No Content
DeleteAllProAuthUsersWithoutAssignedIdpOfSubscription
DELETE
/api/management/v1/ProAuthUser/all/subscription/{subscriptionId}/noidp
Responses
No Content
GetProAuthUserByExternalUniqueUserId
GET
/api/management/v1/ProAuthUser/idp/{idpId}/externaluniqueuser/{id}
Responses
OK
application/json
JSON "id": "string", "isUserActive": true, "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "organizationalUnit": "string", "requestUserDetailsOnNextLogin": true, "scimSynchronized": true, "invitationPending": true, "managerId": "string", "idpInstanceId": "string", "subscriptionId": "string", "twoFactorInstances": "[Circular Reference]", "memberOfGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "proAuthUserProfiles": [ {...} ], "proAuthUserFederatedIdentities": [ {...} ]
{
}
GetScimSynchronizedProAuthUserByScimId
GET
/api/management/v1/ProAuthUser/idp/{idpId}/scim/{id}
Responses
OK
application/json
JSON "id": "string", "isUserActive": true, "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "organizationalUnit": "string", "requestUserDetailsOnNextLogin": true, "scimSynchronized": true, "invitationPending": true, "managerId": "string", "idpInstanceId": "string", "subscriptionId": "string", "twoFactorInstances": "[Circular Reference]", "memberOfGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "proAuthUserProfiles": [ {...} ], "proAuthUserFederatedIdentities": [ {...} ]
{
}
GetSynchronizedProAuthUserByUserStoreId
GET
/api/management/v1/ProAuthUser/idp/{idpId}/userstore/{id}
Responses
OK
application/json
JSON "id": "string", "isUserActive": true, "loginName": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "organizationalUnit": "string", "requestUserDetailsOnNextLogin": true, "scimSynchronized": true, "invitationPending": true, "managerId": "string", "idpInstanceId": "string", "subscriptionId": "string", "twoFactorInstances": "[Circular Reference]", "memberOfGroups": "[Circular Reference]", "authorizedClientApps": "[Circular Reference]", "proAuthUserProfiles": [ {...} ], "proAuthUserFederatedIdentities": [ {...} ]
{
}
SetProAuthUserRequestUserDetails
POST
/api/management/v1/ProAuthUser/requestuserdetails/{id}
Responses
OK
GetProAuthUserByIdpInstanceId
GET
/api/management/v1/ProAuthUser/idp/{idpId}
Responses
OK
application/json
JSON
[
]
GetProAuthUserFederatedConfiguration
GET
/api/management/v1/ProAuthUser/ProAuthUserFederatedConfiguration/{id}
Responses
OK
application/json
JSON "id": "string", "issuer": "string", "subject": "string", "proAuthUserId": "string", "idpInstanceId": "string", "isInternalFederation": true, "isFederatedThroughIdpInstance": true
{
}
GetProAuthUserFederatedConfigurations
GET
/api/management/v1/ProAuthUser/ProAuthUserFederatedConfiguration
Responses
OK
application/json
JSON { "id": "string", "issuer": "string", "subject": "string", "proAuthUserId": "string", "idpInstanceId": "string", "isInternalFederation": true, "isFederatedThroughIdpInstance": true }
[
]
GetProAuthUserInvitations
GET
/api/management/v1/ProAuthUserInvitation
Responses
OK
application/json
JSON { "id": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "isUserActive": true, "subscriptionId": "string", "tenantId": "string" }
[
]
GetProAuthUserInvitation
GET
/api/management/v1/ProAuthUserInvitation/{id}
Responses
OK
application/json
JSON "id": "string", "firstName": "string", "lastName": "string", "emailAddress": "string", "isUserActive": true, "subscriptionId": "string", "tenantId": "string"
{
}
CreateProAuthUserInvitation
POST
/api/management/v1/ProAuthUserInvitation/invite
Request Body
JSON "id": "string", "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"
{
}
SendProAuthUserInvitation
POST
/api/management/v1/ProAuthUserInvitation/invite/send/{id}
Responses
OK
application/json
JSON
true
ProAuthUserProfile
Operations
GET/api/management/v1/ProAuthUser/{proAuthUserId}/ProAuthUserProfile/proAuthUserIdGET/api/management/v1/ProAuthUser/{proAuthUserId}/ProAuthUserProfile/{key}PUT/api/management/v1/ProAuthUser/{proAuthUserId}/ProAuthUserProfile/{key}DELETE/api/management/v1/ProAuthUser/{proAuthUserId}/ProAuthUserProfile/{key}PATCH/api/management/v1/ProAuthUser/{proAuthUserId}/ProAuthUserProfile/{key}PUT/api/management/v1/ProAuthUser/{proAuthUserId}/ProAuthUserProfile/batchPOST/api/management/v1/ProAuthUser/{proAuthUserId}/ProAuthUserProfile/batchDELETE/api/management/v1/ProAuthUser/{proAuthUserId}/ProAuthUserProfile/batchPATCH/api/management/v1/ProAuthUser/{proAuthUserId}/ProAuthUserProfile/batchGET/api/management/v1/ProAuthUser/{proAuthUserId}/ProAuthUserProfilePOST/api/management/v1/ProAuthUser/{proAuthUserId}/ProAuthUserProfilePOST/api/management/v1/ProAuthUser/{proAuthUserId}/ProAuthUserProfile/createorupdatePOST/api/management/v1/ProAuthUser/{proAuthUserId}/ProAuthUserProfile/createorupdate/batch
GetProAuthUserProfilesByProAuthUserId
GET
/api/management/v1/ProAuthUser/{proAuthUserId}/ProAuthUserProfile/proAuthUserId
Responses
OK
application/json
JSON { "proAuthUserId": "string", "key": "string", "value": "string" }
[
]
GetProAuthUserProfile
GET
/api/management/v1/ProAuthUser/{proAuthUserId}/ProAuthUserProfile/{key}
Responses
OK
application/json
JSON "proAuthUserId": "string", "key": "string", "value": "string"
{
}
UpdateProAuthUserProfile
DeleteProAuthUserProfile
DELETE
/api/management/v1/ProAuthUser/{proAuthUserId}/ProAuthUserProfile/{key}
Responses
No Content
PatchProAuthUserProfile
UpdateProAuthUserProfiles
CreateProAuthUserProfiles
DeleteProAuthUserProfiles
PatchProAuthUserProfiles
GetProAuthUserProfiles
GET
/api/management/v1/ProAuthUser/{proAuthUserId}/ProAuthUserProfile
Responses
OK
application/json
JSON
[
]
CreateProAuthUserProfile
CreateOrUpdateProAuthUserProfile
CreateOrUpdateProAuthUserProfiles
ProAuthUserQuestionnaire
Operations
GET/api/management/v1/ProAuthUserQuestionnairePOST/api/management/v1/ProAuthUserQuestionnairePOST/api/management/v1/ProAuthUserQuestionnaire/createorupdateGET/api/management/v1/ProAuthUserQuestionnaire/{id}PUT/api/management/v1/ProAuthUserQuestionnaire/{id}DELETE/api/management/v1/ProAuthUserQuestionnaire/{id}PATCH/api/management/v1/ProAuthUserQuestionnaire/{id}PUT/api/management/v1/ProAuthUserQuestionnaire/batchPOST/api/management/v1/ProAuthUserQuestionnaire/batchDELETE/api/management/v1/ProAuthUserQuestionnaire/batchPATCH/api/management/v1/ProAuthUserQuestionnaire/batchPOST/api/management/v1/ProAuthUserQuestionnaire/createorupdate/batch
GetProAuthUserQuestionnaires
GET
/api/management/v1/ProAuthUserQuestionnaire
Responses
OK
application/json
JSON { "id": "string", "name": "string", "isActive": true, "items": [...], "subscriptionId": "string", "applyToType": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "applyToClientAppId": "string", "applyToIdpTypeId": "string", "applyToIdpInstanceId": "string" }
[
]
CreateProAuthUserQuestionnaire
POST
/api/management/v1/ProAuthUserQuestionnaire
Request Body
JSON "id": "string", "name": "string", "isActive": true, "items": [ {...} ], "subscriptionId": "string", "applyToType": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "applyToClientAppId": "string", "applyToIdpTypeId": "string", "applyToIdpInstanceId": "string"
{
}
Responses
Created
application/json
JSON "id": "string", "name": "string", "isActive": true, "items": [ {...} ], "subscriptionId": "string", "applyToType": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "applyToClientAppId": "string", "applyToIdpTypeId": "string", "applyToIdpInstanceId": "string"
{
}
CreateOrUpdateProAuthUserQuestionnaire
POST
/api/management/v1/ProAuthUserQuestionnaire/createorupdate
Request Body
JSON "id": "string", "name": "string", "isActive": true, "items": [ {...} ], "subscriptionId": "string", "applyToType": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "applyToClientAppId": "string", "applyToIdpTypeId": "string", "applyToIdpInstanceId": "string"
{
}
Responses
Created
application/json
JSON "id": "string", "name": "string", "isActive": true, "items": [ {...} ], "subscriptionId": "string", "applyToType": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "applyToClientAppId": "string", "applyToIdpTypeId": "string", "applyToIdpInstanceId": "string"
{
}
GetProAuthUserQuestionnaire
GET
/api/management/v1/ProAuthUserQuestionnaire/{id}
Responses
OK
application/json
JSON "id": "string", "name": "string", "isActive": true, "items": [ {...} ], "subscriptionId": "string", "applyToType": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "applyToClientAppId": "string", "applyToIdpTypeId": "string", "applyToIdpInstanceId": "string"
{
}
UpdateProAuthUserQuestionnaire
PUT
/api/management/v1/ProAuthUserQuestionnaire/{id}
Request Body
JSON "id": "string", "name": "string", "isActive": true, "items": [ {...} ], "subscriptionId": "string", "applyToType": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "applyToClientAppId": "string", "applyToIdpTypeId": "string", "applyToIdpInstanceId": "string"
{
}
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "isActive": true, "items": [ {...} ], "subscriptionId": "string", "applyToType": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "applyToClientAppId": "string", "applyToIdpTypeId": "string", "applyToIdpInstanceId": "string"
{
}
DeleteProAuthUserQuestionnaire
DELETE
/api/management/v1/ProAuthUserQuestionnaire/{id}
Responses
No Content
PatchProAuthUserQuestionnaire
PATCH
/api/management/v1/ProAuthUserQuestionnaire/{id}
Request Body
JSON { "op": "string", "path": "string", "from": "string", "value": null }
[
]
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "isActive": true, "items": [ {...} ], "subscriptionId": "string", "applyToType": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "applyToClientAppId": "string", "applyToIdpTypeId": "string", "applyToIdpInstanceId": "string"
{
}
UpdateProAuthUserQuestionnaires
CreateProAuthUserQuestionnaires
DeleteProAuthUserQuestionnaires
PatchProAuthUserQuestionnaires
PATCH
/api/management/v1/ProAuthUserQuestionnaire/batch
Request Body
JSON
[
]
Responses
Accepted
application/json
JSON { "id": "string", "name": "string", "isActive": true, "items": [...], "subscriptionId": "string", "applyToType": "string", "applyToSubscriptionId": "string", "applyToTenantId": "string", "applyToClientAppId": "string", "applyToIdpTypeId": "string", "applyToIdpInstanceId": "string" }
[
]
CreateOrUpdateProAuthUserQuestionnaires
ProAuthUserQuestionnaireItem
Operations
GET/api/management/v1/ProAuthUserQuestionnaireItemPOST/api/management/v1/ProAuthUserQuestionnaireItemPOST/api/management/v1/ProAuthUserQuestionnaireItem/createorupdateGET/api/management/v1/ProAuthUserQuestionnaireItem/{id}PUT/api/management/v1/ProAuthUserQuestionnaireItem/{id}DELETE/api/management/v1/ProAuthUserQuestionnaireItem/{id}PATCH/api/management/v1/ProAuthUserQuestionnaireItem/{id}PUT/api/management/v1/ProAuthUserQuestionnaireItem/batchPOST/api/management/v1/ProAuthUserQuestionnaireItem/batchDELETE/api/management/v1/ProAuthUserQuestionnaireItem/batchPATCH/api/management/v1/ProAuthUserQuestionnaireItem/batchPOST/api/management/v1/ProAuthUserQuestionnaireItem/createorupdate/batch
GetProAuthUserQuestionnaireItems
GET
/api/management/v1/ProAuthUserQuestionnaireItem
Responses
OK
application/json
JSON { "id": "string", "position": 0, "questionnaireItemType": "string", "key": "string", "value": "string", "labelId": "string", "labelPlaceholderId": "string", "proAuthUserQuestionnaireId": "string" }
[
]
CreateProAuthUserQuestionnaireItem
POST
/api/management/v1/ProAuthUserQuestionnaireItem
Request Body
JSON "id": "string", "position": 0, "questionnaireItemType": "string", "key": "string", "value": "string", "labelId": "string", "labelPlaceholderId": "string", "proAuthUserQuestionnaireId": "string"
{
}
Responses
Created
application/json
JSON "id": "string", "position": 0, "questionnaireItemType": "string", "key": "string", "value": "string", "labelId": "string", "labelPlaceholderId": "string", "proAuthUserQuestionnaireId": "string"
{
}
CreateOrUpdateProAuthUserQuestionnaireItem
POST
/api/management/v1/ProAuthUserQuestionnaireItem/createorupdate
Request Body
JSON "id": "string", "position": 0, "questionnaireItemType": "string", "key": "string", "value": "string", "labelId": "string", "labelPlaceholderId": "string", "proAuthUserQuestionnaireId": "string"
{
}
Responses
Created
application/json
JSON "id": "string", "position": 0, "questionnaireItemType": "string", "key": "string", "value": "string", "labelId": "string", "labelPlaceholderId": "string", "proAuthUserQuestionnaireId": "string"
{
}
GetProAuthUserQuestionnaireItem
GET
/api/management/v1/ProAuthUserQuestionnaireItem/{id}
Responses
OK
application/json
JSON "id": "string", "position": 0, "questionnaireItemType": "string", "key": "string", "value": "string", "labelId": "string", "labelPlaceholderId": "string", "proAuthUserQuestionnaireId": "string"
{
}
UpdateProAuthUserQuestionnaireItem
PUT
/api/management/v1/ProAuthUserQuestionnaireItem/{id}
Request Body
JSON "id": "string", "position": 0, "questionnaireItemType": "string", "key": "string", "value": "string", "labelId": "string", "labelPlaceholderId": "string", "proAuthUserQuestionnaireId": "string"
{
}
Responses
Accepted
application/json
JSON "id": "string", "position": 0, "questionnaireItemType": "string", "key": "string", "value": "string", "labelId": "string", "labelPlaceholderId": "string", "proAuthUserQuestionnaireId": "string"
{
}
DeleteProAuthUserQuestionnaireItem
DELETE
/api/management/v1/ProAuthUserQuestionnaireItem/{id}
Responses
No Content
PatchProAuthUserQuestionnaireItem
PATCH
/api/management/v1/ProAuthUserQuestionnaireItem/{id}
Request Body
JSON { "op": "string", "path": "string", "from": "string", "value": null }
[
]
Responses
Accepted
application/json
JSON "id": "string", "position": 0, "questionnaireItemType": "string", "key": "string", "value": "string", "labelId": "string", "labelPlaceholderId": "string", "proAuthUserQuestionnaireId": "string"
{
}
UpdateProAuthUserQuestionnaireItems
CreateProAuthUserQuestionnaireItems
DeleteProAuthUserQuestionnaireItems
PatchProAuthUserQuestionnaireItems
PATCH
/api/management/v1/ProAuthUserQuestionnaireItem/batch
Request Body
JSON
[
]
Responses
Accepted
application/json
JSON { "id": "string", "position": 0, "questionnaireItemType": "string", "key": "string", "value": "string", "labelId": "string", "labelPlaceholderId": "string", "proAuthUserQuestionnaireId": "string" }
[
]
CreateOrUpdateProAuthUserQuestionnaireItems
ProAuthUserRole
Operations
GET/api/management/v1/ProAuthUser/ProAuthUserRole/proauthuser/{proAuthUserId}GET/api/management/v1/ProAuthUser/ProAuthUserRolePOST/api/management/v1/ProAuthUser/ProAuthUserRolePOST/api/management/v1/ProAuthUser/ProAuthUserRole/createorupdateGET/api/management/v1/ProAuthUser/ProAuthUserRole/{id}PUT/api/management/v1/ProAuthUser/ProAuthUserRole/{id}DELETE/api/management/v1/ProAuthUser/ProAuthUserRole/{id}PATCH/api/management/v1/ProAuthUser/ProAuthUserRole/{id}PUT/api/management/v1/ProAuthUser/ProAuthUserRole/batchPOST/api/management/v1/ProAuthUser/ProAuthUserRole/batchDELETE/api/management/v1/ProAuthUser/ProAuthUserRole/batchPATCH/api/management/v1/ProAuthUser/ProAuthUserRole/batchPOST/api/management/v1/ProAuthUser/ProAuthUserRole/createorupdate/batch
GetProAuthUserRolesByUser
GET
/api/management/v1/ProAuthUser/ProAuthUserRole/proauthuser/{proAuthUserId}
Responses
OK
application/json
JSON { "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "proAuthUserId": "string" }
[
]
GetProAuthUserRoles
GET
/api/management/v1/ProAuthUser/ProAuthUserRole
Responses
OK
application/json
JSON { "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "proAuthUserId": "string" }
[
]
CreateProAuthUserRole
POST
/api/management/v1/ProAuthUser/ProAuthUserRole
Request Body
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "proAuthUserId": "string"
{
}
Responses
Created
application/json
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "proAuthUserId": "string"
{
}
CreateOrUpdateProAuthUserRole
POST
/api/management/v1/ProAuthUser/ProAuthUserRole/createorupdate
Request Body
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "proAuthUserId": "string"
{
}
Responses
Created
application/json
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "proAuthUserId": "string"
{
}
GetProAuthUserRole
GET
/api/management/v1/ProAuthUser/ProAuthUserRole/{id}
Responses
OK
application/json
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "proAuthUserId": "string"
{
}
UpdateProAuthUserRole
PUT
/api/management/v1/ProAuthUser/ProAuthUserRole/{id}
Request Body
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "proAuthUserId": "string"
{
}
Responses
Accepted
application/json
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "proAuthUserId": "string"
{
}
PatchProAuthUserRole
PATCH
/api/management/v1/ProAuthUser/ProAuthUserRole/{id}
Request Body
JSON { "op": "string", "path": "string", "from": "string", "value": null }
[
]
Responses
Accepted
application/json
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "proAuthUserId": "string"
{
}
UpdateProAuthUserRoles
CreateProAuthUserRoles
DeleteProAuthUserRoles
PatchProAuthUserRoles
CreateOrUpdateProAuthUserRoles
ProAuthUserSecondFactor
Operations
GET/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/proAuthUser/{proAuthUserId}/type/{secondFactorType}GET/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/proAuthUser/{proAuthUserId}GET/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/proAuthUser/{proAuthUserId}/recoverycodePOST/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/proAuthUser/{proAuthUserId}/recoverycodeGET/api/management/v1/ProAuthUser/ProAuthUserSecondFactorPOST/api/management/v1/ProAuthUser/ProAuthUserSecondFactorPOST/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/createorupdateGET/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/{id}PUT/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/{id}DELETE/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/{id}PATCH/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/{id}PUT/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/batchPOST/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/batchDELETE/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/batchPATCH/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/batchPOST/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/createorupdate/batch
GetSecondFactorByType
GET
/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/proAuthUser/{proAuthUserId}/type/{secondFactorType}
Responses
OK
application/json
JSON "id": "string", "secondFactorType": "string", "secondFactorValue": "string", "confirmed": true, "confirmationCodeExpiration": "string", "proAuthUserId": "string"
{
}
GetSecondFactorsByProAuthUserId
GET
/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/proAuthUser/{proAuthUserId}
Responses
OK
application/json
JSON { "id": "string", "secondFactorType": "string", "secondFactorValue": "string", "confirmed": true, "confirmationCodeExpiration": "string", "proAuthUserId": "string" }
[
]
GetTwoFactorRecoveryCodeSet
GET
/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/proAuthUser/{proAuthUserId}/recoverycode
Responses
OK
application/json
JSON { "id": "string", "recoveryCode": "string", "recoveryGroup": "string", "redeemed": true, "redeemTimeStamp": "string", "invalidated": true, "invalidatedTimeStamp": "string", "proAuthUserId": "string" }
[
]
CreateTwoFactorRecoveryCodes
POST
/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/proAuthUser/{proAuthUserId}/recoverycode
Responses
Created
application/json
JSON { "id": "string", "recoveryCode": "string", "recoveryGroup": "string", "redeemed": true, "redeemTimeStamp": "string", "invalidated": true, "invalidatedTimeStamp": "string", "proAuthUserId": "string" }
[
]
GetProAuthUserSecondFactors
GET
/api/management/v1/ProAuthUser/ProAuthUserSecondFactor
Responses
OK
application/json
JSON { "id": "string", "secondFactorType": "string", "secondFactorValue": "string", "confirmed": true, "confirmationCodeExpiration": "string", "proAuthUserId": "string" }
[
]
CreateProAuthUserSecondFactor
POST
/api/management/v1/ProAuthUser/ProAuthUserSecondFactor
Request Body
JSON "id": "string", "secondFactorType": "string", "secondFactorValue": "string", "confirmed": true, "confirmationCodeExpiration": "string", "proAuthUserId": "string"
{
}
Responses
Created
application/json
JSON "id": "string", "secondFactorType": "string", "secondFactorValue": "string", "confirmed": true, "confirmationCodeExpiration": "string", "proAuthUserId": "string"
{
}
CreateOrUpdateProAuthUserSecondFactor
POST
/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/createorupdate
Request Body
JSON "id": "string", "secondFactorType": "string", "secondFactorValue": "string", "confirmed": true, "confirmationCodeExpiration": "string", "proAuthUserId": "string"
{
}
Responses
Created
application/json
JSON "id": "string", "secondFactorType": "string", "secondFactorValue": "string", "confirmed": true, "confirmationCodeExpiration": "string", "proAuthUserId": "string"
{
}
GetProAuthUserSecondFactor
GET
/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/{id}
Responses
OK
application/json
JSON "id": "string", "secondFactorType": "string", "secondFactorValue": "string", "confirmed": true, "confirmationCodeExpiration": "string", "proAuthUserId": "string"
{
}
UpdateProAuthUserSecondFactor
PUT
/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/{id}
Request Body
JSON "id": "string", "secondFactorType": "string", "secondFactorValue": "string", "confirmed": true, "confirmationCodeExpiration": "string", "proAuthUserId": "string"
{
}
Responses
Accepted
application/json
JSON "id": "string", "secondFactorType": "string", "secondFactorValue": "string", "confirmed": true, "confirmationCodeExpiration": "string", "proAuthUserId": "string"
{
}
DeleteProAuthUserSecondFactor
DELETE
/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/{id}
Responses
No Content
PatchProAuthUserSecondFactor
PATCH
/api/management/v1/ProAuthUser/ProAuthUserSecondFactor/{id}
Request Body
JSON { "op": "string", "path": "string", "from": "string", "value": null }
[
]
Responses
Accepted
application/json
JSON "id": "string", "secondFactorType": "string", "secondFactorValue": "string", "confirmed": true, "confirmationCodeExpiration": "string", "proAuthUserId": "string"
{
}
UpdateProAuthUserSecondFactors
CreateProAuthUserSecondFactors
DeleteProAuthUserSecondFactors
PatchProAuthUserSecondFactors
CreateOrUpdateProAuthUserSecondFactors
ClientApp
Operations
GET/api/management/v1/ClientApp/subscription/{subscriptionId}GET/api/management/v1/ClientAppPOST/api/management/v1/ClientAppPOST/api/management/v1/ClientApp/createorupdateGET/api/management/v1/ClientApp/{id}PUT/api/management/v1/ClientApp/{id}DELETE/api/management/v1/ClientApp/{id}PATCH/api/management/v1/ClientApp/{id}PUT/api/management/v1/ClientApp/batchPOST/api/management/v1/ClientApp/batchDELETE/api/management/v1/ClientApp/batchPATCH/api/management/v1/ClientApp/batchPOST/api/management/v1/ClientApp/createorupdate/batch
GetClientAppsBySubscriptionId
GET
/api/management/v1/ClientApp/subscription/{subscriptionId}
Responses
OK
application/json
JSON { "id": "string", "name": "string", "accessGrantConsent": "string", "logoutConsent": "string", "resourceFilterEnabled": true, "scopeFilterEnabled": true, "clientUri": "string", "logoUri": "string", "enabled": true, "isPublic": true, "isRestricted": true, "includeGroupsClaims": true, "allowCrossSubscription": true, "allowUserLogin": true, "allowClientCredentialLogin": true, "subscriptionId": "string", "clientAppSecrets": [...], "clientAppResources": [...], "clientAppScopes": [...], "clientAppRedirectUris": [...], "metadata": [...], "clientAppFederatedIdentities": [...], "idpInstances": "[Circular Reference]", "twoFactorInstances": "[Circular Reference]", "claimRules": [...], "tenants": [...], "authorizedProAuthGroups": [...], "authorizedProAuthUsers": [...], "allowedTokenExchangeClientApps": "[Circular Reference]" }
[
]
CreateClientApp
POST
/api/management/v1/ClientApp
Request Body
JSON "id": "string", "name": "string", "accessGrantConsent": "string", "logoutConsent": "string", "resourceFilterEnabled": true, "scopeFilterEnabled": true, "clientUri": "string", "logoUri": "string", "enabled": true, "isPublic": true, "isRestricted": true, "includeGroupsClaims": true, "allowCrossSubscription": true, "allowUserLogin": true, "allowClientCredentialLogin": true, "subscriptionId": "string", "clientAppSecrets": [ {...} ], "clientAppResources": [ {...} ], "clientAppScopes": [ {...} ], "clientAppRedirectUris": [ {...} ], "metadata": [ {...} ], "clientAppFederatedIdentities": [ {...} ], "idpInstances": "[Circular Reference]", "twoFactorInstances": "[Circular Reference]", "claimRules": [ {...} ], "tenants": [ {...} ], "authorizedProAuthGroups": [ {...} ], "authorizedProAuthUsers": [ ], "allowedTokenExchangeClientApps": "[Circular Reference]"
{
}
Responses
Created
application/json
JSON "id": "string", "name": "string", "accessGrantConsent": "string", "logoutConsent": "string", "resourceFilterEnabled": true, "scopeFilterEnabled": true, "clientUri": "string", "logoUri": "string", "enabled": true, "isPublic": true, "isRestricted": true, "includeGroupsClaims": true, "allowCrossSubscription": true, "allowUserLogin": true, "allowClientCredentialLogin": true, "subscriptionId": "string", "clientAppSecrets": [ {...} ], "clientAppResources": [ {...} ], "clientAppScopes": [ {...} ], "clientAppRedirectUris": [ {...} ], "metadata": [ {...} ], "clientAppFederatedIdentities": [ {...} ], "idpInstances": "[Circular Reference]", "twoFactorInstances": "[Circular Reference]", "claimRules": [ {...} ], "tenants": [ {...} ], "authorizedProAuthGroups": [ {...} ], "authorizedProAuthUsers": [ ], "allowedTokenExchangeClientApps": "[Circular Reference]"
{
}
CreateOrUpdateClientApp
POST
/api/management/v1/ClientApp/createorupdate
Request Body
JSON "id": "string", "name": "string", "accessGrantConsent": "string", "logoutConsent": "string", "resourceFilterEnabled": true, "scopeFilterEnabled": true, "clientUri": "string", "logoUri": "string", "enabled": true, "isPublic": true, "isRestricted": true, "includeGroupsClaims": true, "allowCrossSubscription": true, "allowUserLogin": true, "allowClientCredentialLogin": true, "subscriptionId": "string", "clientAppSecrets": [ {...} ], "clientAppResources": [ {...} ], "clientAppScopes": [ {...} ], "clientAppRedirectUris": [ {...} ], "metadata": [ {...} ], "clientAppFederatedIdentities": [ {...} ], "idpInstances": "[Circular Reference]", "twoFactorInstances": "[Circular Reference]", "claimRules": [ {...} ], "tenants": [ {...} ], "authorizedProAuthGroups": [ {...} ], "authorizedProAuthUsers": [ ], "allowedTokenExchangeClientApps": "[Circular Reference]"
{
}
Responses
Created
application/json
JSON "id": "string", "name": "string", "accessGrantConsent": "string", "logoutConsent": "string", "resourceFilterEnabled": true, "scopeFilterEnabled": true, "clientUri": "string", "logoUri": "string", "enabled": true, "isPublic": true, "isRestricted": true, "includeGroupsClaims": true, "allowCrossSubscription": true, "allowUserLogin": true, "allowClientCredentialLogin": true, "subscriptionId": "string", "clientAppSecrets": [ {...} ], "clientAppResources": [ {...} ], "clientAppScopes": [ {...} ], "clientAppRedirectUris": [ {...} ], "metadata": [ {...} ], "clientAppFederatedIdentities": [ {...} ], "idpInstances": "[Circular Reference]", "twoFactorInstances": "[Circular Reference]", "claimRules": [ {...} ], "tenants": [ {...} ], "authorizedProAuthGroups": [ {...} ], "authorizedProAuthUsers": [ ], "allowedTokenExchangeClientApps": "[Circular Reference]"
{
}
GetClientApp
GET
/api/management/v1/ClientApp/{id}
Responses
OK
application/json
JSON "id": "string", "name": "string", "accessGrantConsent": "string", "logoutConsent": "string", "resourceFilterEnabled": true, "scopeFilterEnabled": true, "clientUri": "string", "logoUri": "string", "enabled": true, "isPublic": true, "isRestricted": true, "includeGroupsClaims": true, "allowCrossSubscription": true, "allowUserLogin": true, "allowClientCredentialLogin": true, "subscriptionId": "string", "clientAppSecrets": [ {...} ], "clientAppResources": [ {...} ], "clientAppScopes": [ {...} ], "clientAppRedirectUris": [ {...} ], "metadata": [ {...} ], "clientAppFederatedIdentities": [ {...} ], "idpInstances": "[Circular Reference]", "twoFactorInstances": "[Circular Reference]", "claimRules": [ {...} ], "tenants": [ {...} ], "authorizedProAuthGroups": [ {...} ], "authorizedProAuthUsers": [ ], "allowedTokenExchangeClientApps": "[Circular Reference]"
{
}
UpdateClientApp
PUT
/api/management/v1/ClientApp/{id}
Request Body
JSON "id": "string", "name": "string", "accessGrantConsent": "string", "logoutConsent": "string", "resourceFilterEnabled": true, "scopeFilterEnabled": true, "clientUri": "string", "logoUri": "string", "enabled": true, "isPublic": true, "isRestricted": true, "includeGroupsClaims": true, "allowCrossSubscription": true, "allowUserLogin": true, "allowClientCredentialLogin": true, "subscriptionId": "string", "clientAppSecrets": [ {...} ], "clientAppResources": [ {...} ], "clientAppScopes": [ {...} ], "clientAppRedirectUris": [ {...} ], "metadata": [ {...} ], "clientAppFederatedIdentities": [ {...} ], "idpInstances": "[Circular Reference]", "twoFactorInstances": "[Circular Reference]", "claimRules": [ {...} ], "tenants": [ {...} ], "authorizedProAuthGroups": [ {...} ], "authorizedProAuthUsers": [ ], "allowedTokenExchangeClientApps": "[Circular Reference]"
{
}
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "accessGrantConsent": "string", "logoutConsent": "string", "resourceFilterEnabled": true, "scopeFilterEnabled": true, "clientUri": "string", "logoUri": "string", "enabled": true, "isPublic": true, "isRestricted": true, "includeGroupsClaims": true, "allowCrossSubscription": true, "allowUserLogin": true, "allowClientCredentialLogin": true, "subscriptionId": "string", "clientAppSecrets": [ {...} ], "clientAppResources": [ {...} ], "clientAppScopes": [ {...} ], "clientAppRedirectUris": [ {...} ], "metadata": [ {...} ], "clientAppFederatedIdentities": [ {...} ], "idpInstances": "[Circular Reference]", "twoFactorInstances": "[Circular Reference]", "claimRules": [ {...} ], "tenants": [ {...} ], "authorizedProAuthGroups": [ {...} ], "authorizedProAuthUsers": [ ], "allowedTokenExchangeClientApps": "[Circular Reference]"
{
}
PatchClientApp
PATCH
/api/management/v1/ClientApp/{id}
Request Body
JSON { "op": "string", "path": "string", "from": "string", "value": null }
[
]
Responses
Accepted
application/json
JSON "id": "string", "name": "string", "accessGrantConsent": "string", "logoutConsent": "string", "resourceFilterEnabled": true, "scopeFilterEnabled": true, "clientUri": "string", "logoUri": "string", "enabled": true, "isPublic": true, "isRestricted": true, "includeGroupsClaims": true, "allowCrossSubscription": true, "allowUserLogin": true, "allowClientCredentialLogin": true, "subscriptionId": "string", "clientAppSecrets": [ {...} ], "clientAppResources": [ {...} ], "clientAppScopes": [ {...} ], "clientAppRedirectUris": [ {...} ], "metadata": [ {...} ], "clientAppFederatedIdentities": [ {...} ], "idpInstances": "[Circular Reference]", "twoFactorInstances": "[Circular Reference]", "claimRules": [ {...} ], "tenants": [ {...} ], "authorizedProAuthGroups": [ {...} ], "authorizedProAuthUsers": [ ], "allowedTokenExchangeClientApps": "[Circular Reference]"
{
}
UpdateClientApps
CreateClientApps
PatchClientApps
PATCH
/api/management/v1/ClientApp/batch
Request Body
JSON
[
]
Responses
Accepted
application/json
JSON { "id": "string", "name": "string", "accessGrantConsent": "string", "logoutConsent": "string", "resourceFilterEnabled": true, "scopeFilterEnabled": true, "clientUri": "string", "logoUri": "string", "enabled": true, "isPublic": true, "isRestricted": true, "includeGroupsClaims": true, "allowCrossSubscription": true, "allowUserLogin": true, "allowClientCredentialLogin": true, "subscriptionId": "string", "clientAppSecrets": [...], "clientAppResources": [...], "clientAppScopes": [...], "clientAppRedirectUris": [...], "metadata": [...], "clientAppFederatedIdentities": [...], "idpInstances": "[Circular Reference]", "twoFactorInstances": "[Circular Reference]", "claimRules": [...], "tenants": [...], "authorizedProAuthGroups": [...], "authorizedProAuthUsers": [...], "allowedTokenExchangeClientApps": "[Circular Reference]" }
[
]
CreateOrUpdateClientApps
ClientAppMetadata
Operations
GET/api/management/v1/ClientApp/{clientAppId}/ClientAppMetadata/clientAppIdGET/api/management/v1/ClientApp/{clientAppId}/ClientAppMetadata/{key}PUT/api/management/v1/ClientApp/{clientAppId}/ClientAppMetadata/{key}DELETE/api/management/v1/ClientApp/{clientAppId}/ClientAppMetadata/{key}PATCH/api/management/v1/ClientApp/{clientAppId}/ClientAppMetadata/{key}PUT/api/management/v1/ClientApp/{clientAppId}/ClientAppMetadata/batchPOST/api/management/v1/ClientApp/{clientAppId}/ClientAppMetadata/batchDELETE/api/management/v1/ClientApp/{clientAppId}/ClientAppMetadata/batchPATCH/api/management/v1/ClientApp/{clientAppId}/ClientAppMetadata/batchGET/api/management/v1/ClientApp/{clientAppId}/ClientAppMetadataPOST/api/management/v1/ClientApp/{clientAppId}/ClientAppMetadataPOST/api/management/v1/ClientApp/{clientAppId}/ClientAppMetadata/createorupdatePOST/api/management/v1/ClientApp/{clientAppId}/ClientAppMetadata/createorupdate/batch
GetClientAppMetadataByClientAppId
GET
/api/management/v1/ClientApp/{clientAppId}/ClientAppMetadata/clientAppId
Responses
OK
application/json
JSON { "clientAppId": "string", "key": "string", "value": "string" }
[
]
GetClientAppMetadata
GET
/api/management/v1/ClientApp/{clientAppId}/ClientAppMetadata/{key}
Responses
OK
application/json
JSON "clientAppId": "string", "key": "string", "value": "string"
{
}
UpdateClientAppMetadata
DeleteClientAppMetadata
DELETE
/api/management/v1/ClientApp/{clientAppId}/ClientAppMetadata/{key}
Responses
No Content
PatchClientAppMetadata
UpdateClientAppMetadatas
CreateClientAppMetadatas
DeleteClientAppMetadatas
PatchClientAppMetadatas
GetClientAppMetadatas
GET
/api/management/v1/ClientApp/{clientAppId}/ClientAppMetadata
Responses
OK
application/json
JSON
[
]
CreateClientAppMetadata
CreateOrUpdateClientAppMetadata
CreateOrUpdateClientAppMetadatas
ClientAppRedirectUri
Operations
GET/api/management/v1/ClientApp/ClientAppRedirectUri/clientapp/{clientAppId}GET/api/management/v1/ClientApp/ClientAppRedirectUriPOST/api/management/v1/ClientApp/ClientAppRedirectUriPOST/api/management/v1/ClientApp/ClientAppRedirectUri/createorupdateGET/api/management/v1/ClientApp/ClientAppRedirectUri/{id}PUT/api/management/v1/ClientApp/ClientAppRedirectUri/{id}DELETE/api/management/v1/ClientApp/ClientAppRedirectUri/{id}PATCH/api/management/v1/ClientApp/ClientAppRedirectUri/{id}PUT/api/management/v1/ClientApp/ClientAppRedirectUri/batchPOST/api/management/v1/ClientApp/ClientAppRedirectUri/batchDELETE/api/management/v1/ClientApp/ClientAppRedirectUri/batchPATCH/api/management/v1/ClientApp/ClientAppRedirectUri/batchPOST/api/management/v1/ClientApp/ClientAppRedirectUri/createorupdate/batch
GetClientAppRedirectUrisByClientAppId
GET
/api/management/v1/ClientApp/ClientAppRedirectUri/clientapp/{clientAppId}
Responses
OK
application/json
JSON { "id": "string", "uri": "string", "redirectType": "string", "clientAppId": "string" }
[
]
GetClientAppRedirectUris
GET
/api/management/v1/ClientApp/ClientAppRedirectUri
Responses
OK
application/json
JSON
[
]
CreateClientAppRedirectUri
CreateOrUpdateClientAppRedirectUri
GetClientAppRedirectUri
GET
/api/management/v1/ClientApp/ClientAppRedirectUri/{id}
Responses
OK
application/json
JSON "id": "string", "uri": "string", "redirectType": "string", "clientAppId": "string"
{
}
UpdateClientAppRedirectUri
DeleteClientAppRedirectUri
DELETE
/api/management/v1/ClientApp/ClientAppRedirectUri/{id}
Responses
No Content
PatchClientAppRedirectUri
UpdateClientAppRedirectUris
CreateClientAppRedirectUris
DeleteClientAppRedirectUris
PatchClientAppRedirectUris
CreateOrUpdateClientAppRedirectUris
ClientAppResource
Operations
GET/api/management/v1/ClientApp/ClientAppResource/clientapp/{clientAppId}GET/api/management/v1/ClientApp/ClientAppResourcePOST/api/management/v1/ClientApp/ClientAppResourcePOST/api/management/v1/ClientApp/ClientAppResource/createorupdateGET/api/management/v1/ClientApp/ClientAppResource/{id}PUT/api/management/v1/ClientApp/ClientAppResource/{id}DELETE/api/management/v1/ClientApp/ClientAppResource/{id}PATCH/api/management/v1/ClientApp/ClientAppResource/{id}PUT/api/management/v1/ClientApp/ClientAppResource/batchPOST/api/management/v1/ClientApp/ClientAppResource/batchDELETE/api/management/v1/ClientApp/ClientAppResource/batchPATCH/api/management/v1/ClientApp/ClientAppResource/batchPOST/api/management/v1/ClientApp/ClientAppResource/createorupdate/batch
GetClientAppResourcesByClientAppId
GET
/api/management/v1/ClientApp/ClientAppResource/clientapp/{clientAppId}
Responses
OK
application/json
JSON { "id": "string", "key": "string", "name": "string", "description": "string", "clientAppId": "string" }
[
]
GetClientAppResources
GET
/api/management/v1/ClientApp/ClientAppResource
Responses
OK
application/json
JSON
[
]
CreateClientAppResource
POST
/api/management/v1/ClientApp/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"
{
}
CreateOrUpdateClientAppResource
POST
/api/management/v1/ClientApp/ClientAppResource/createorupdate
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"
{
}
GetClientAppResource
GET
/api/management/v1/ClientApp/ClientAppResource/{id}
Responses
OK
application/json
JSON "id": "string", "key": "string", "name": "string", "description": "string", "clientAppId": "string"
{
}
UpdateClientAppResource
PUT
/api/management/v1/ClientApp/ClientAppResource/{id}
Request Body
JSON "id": "string", "key": "string", "name": "string", "description": "string", "clientAppId": "string"
{
}
Responses
Accepted
application/json
JSON "id": "string", "key": "string", "name": "string", "description": "string", "clientAppId": "string"
{
}
DeleteClientAppResource
DELETE
/api/management/v1/ClientApp/ClientAppResource/{id}
Responses
No Content
PatchClientAppResource
UpdateClientAppResources
CreateClientAppResources
DeleteClientAppResources
PatchClientAppResources
CreateOrUpdateClientAppResources
ClientAppRole
Operations
GET/api/management/v1/ClientApp/ClientAppRole/clientapp/{clientAppId}GET/api/management/v1/ClientApp/ClientAppRolePOST/api/management/v1/ClientApp/ClientAppRolePOST/api/management/v1/ClientApp/ClientAppRole/createorupdateGET/api/management/v1/ClientApp/ClientAppRole/{id}PUT/api/management/v1/ClientApp/ClientAppRole/{id}DELETE/api/management/v1/ClientApp/ClientAppRole/{id}PATCH/api/management/v1/ClientApp/ClientAppRole/{id}PUT/api/management/v1/ClientApp/ClientAppRole/batchPOST/api/management/v1/ClientApp/ClientAppRole/batchDELETE/api/management/v1/ClientApp/ClientAppRole/batchPATCH/api/management/v1/ClientApp/ClientAppRole/batchPOST/api/management/v1/ClientApp/ClientAppRole/createorupdate/batch
GetClientAppRolesByClientAppId
GET
/api/management/v1/ClientApp/ClientAppRole/clientapp/{clientAppId}
Responses
OK
application/json
JSON { "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "clientAppId": "string" }
[
]
CreateClientAppRole
POST
/api/management/v1/ClientApp/ClientAppRole
Request Body
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "clientAppId": "string"
{
}
Responses
Created
application/json
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "clientAppId": "string"
{
}
CreateOrUpdateClientAppRole
POST
/api/management/v1/ClientApp/ClientAppRole/createorupdate
Request Body
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "clientAppId": "string"
{
}
Responses
Created
application/json
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "clientAppId": "string"
{
}
GetClientAppRole
GET
/api/management/v1/ClientApp/ClientAppRole/{id}
Responses
OK
application/json
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "clientAppId": "string"
{
}
UpdateClientAppRole
PUT
/api/management/v1/ClientApp/ClientAppRole/{id}
Request Body
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "clientAppId": "string"
{
}
Responses
Accepted
application/json
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "clientAppId": "string"
{
}
PatchClientAppRole
PATCH
/api/management/v1/ClientApp/ClientAppRole/{id}
Request Body
JSON { "op": "string", "path": "string", "from": "string", "value": null }
[
]
Responses
Accepted
application/json
JSON "id": "string", "roleType": "string", "applyToTenantId": "string", "applyToIdpInstanceId": "string", "clientAppId": "string"
{
}
UpdateClientAppRoles
CreateClientAppRoles
DeleteClientAppRoles
PatchClientAppRoles
CreateOrUpdateClientAppRoles
ClientAppScope
Operations
GET/api/management/v1/ClientApp/ClientAppScope/clientapp/{clientAppId}GET/api/management/v1/ClientApp/ClientAppScopePOST/api/management/v1/ClientApp/ClientAppScopePOST/api/management/v1/ClientApp/ClientAppScope/createorupdateGET/api/management/v1/ClientApp/ClientAppScope/{id}PUT/api/management/v1/ClientApp/ClientAppScope/{id}DELETE/api/management/v1/ClientApp/ClientAppScope/{id}PATCH/api/management/v1/ClientApp/ClientAppScope/{id}PUT/api/management/v1/ClientApp/ClientAppScope/batchPOST/api/management/v1/ClientApp/ClientAppScope/batchDELETE/api/management/v1/ClientApp/ClientAppScope/batchPATCH/api/management/v1/ClientApp/ClientAppScope/batchPOST/api/management/v1/ClientApp/ClientAppScope/createorupdate/batch
GetClientAppScopesByClientAppId
GET
/api/management/v1/ClientApp/ClientAppScope/clientapp/{clientAppId}
Responses
OK
application/json
JSON { "id": "string", "key": "string", "name": "string", "description": "string", "clientAppId": "string" }
[
]
GetClientAppScopes
GET
/api/management/v1/ClientApp/ClientAppScope
Responses
OK
application/json
JSON
[
]
CreateClientAppScope
POST
/api/management/v1/ClientApp/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"
{
}
CreateOrUpdateClientAppScope
POST
/api/management/v1/ClientApp/ClientAppScope/createorupdate
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"
{
}
GetClientAppScope
GET
/api/management/v1/ClientApp/ClientAppScope/{id}
Responses
OK
application/json
JSON "id": "string", "key": "string", "name": "string", "description": "string", "clientAppId": "string"
{
}
UpdateClientAppScope
PUT
/api/management/v1/ClientApp/ClientAppScope/{id}
Request Body
JSON "id": "string", "key": "string", "name": "string", "description": "string", "clientAppId": "string"
{
}
Responses
Accepted
application/json
JSON "id": "string", "key": "string", "name": "string", "description": "string", "clientAppId": "string"
{
}