Security Principals

List

get

Retrieve Criteria Security Principal List of a Site Defaults object.

Query parameters

siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to retrieve the Criteria settings (optional).

Responses

200

Success

application/json; api-version=1.0

Security Principal Criteria Entry

accountstring · nullableOptional

The name of the user/group account the filter is added to.

typestring · enumOptional

User Type

Possible values:

sidstring · nullableOptional

The SID of the user/group account the filter is added to.

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/MFADefaultSettings/Criteria/SecurityPrincipals

HTTPcURLJavaScriptPython

GET /api/MFADefaultSettings/Criteria/SecurityPrincipals HTTP/1.1
Accept: */*

[
  {
    "account": "text",
    "type": [
      "1 = User",
      "2 = Group",
      "3 = ForeignSecurityPrincipal",
      "4 = Computer"
    ],
    "sid": "text"
  }
]

Add

post

Add a user, group or machine to the Security Principal List of the Criteria settings.

Query parameters

siteIdinteger · int32Optional

The Site ID of an object for which to modify the Criteria settings (optional).

Body

application/json; api-version=1.0

Add a user, group or machine account to the Criteria security principal list

accountstring · min: 1 · max: 255 · nullableOptional

The name of the account to add to the Criteria.

sidstring · min: 1 · max: 255 · nullableOptional

The SID of the account to add to the Criteria.

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

/api/MFADefaultSettings/Criteria/SecurityPrincipals

HTTPcURLJavaScriptPython

POST /api/MFADefaultSettings/Criteria/SecurityPrincipals HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

{
  "account": "text",
  "sid": "text"
}

No content

Remove

delete

Remove a user, group or machine from the Security Principal List of the Criteria settings.

Query parameters

siteIdinteger · int32Optional

The Site ID of an object for which to modify the Criteria settings (optional).

Body

application/json; api-version=1.0

Remove a user, group or machine from the Criteria security principal list

accountstring · min: 1 · max: 255 · nullableOptional

The name of the account to remove from the Criteria.

sidstring · min: 1 · max: 255 · nullableOptional

The SID of the account to remove from the Criteria.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

/api/MFADefaultSettings/Criteria/SecurityPrincipals

HTTPcURLJavaScriptPython

DELETE /api/MFADefaultSettings/Criteria/SecurityPrincipals HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

{
  "account": "text",
  "sid": "text"
}

No content