Security Principals

List

get

Retrieve Criteria Security Principal List of a session server with the specified ID.

Path parameters
idinteger · int32Required

The ID of a session server for which to retrieve the Criteria settings.

Responses
application/json; api-version=1.0
object[]Optional

Security Principal Criteria Entry

get
GET /api/MFA/{id}/Criteria/SecurityPrincipals HTTP/1.1
Host: 
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.

Path parameters
idinteger · int32Required

The ID of a session server for which to modify the Criteria settings.

Body

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

accountstring | nullableOptional

The name of the account to add to the Criteria.

sidstring | nullableOptional

The SID of the account to add to the Criteria.

Responses
post
POST /api/MFA/{id}/Criteria/SecurityPrincipals HTTP/1.1
Host: 
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.

Path parameters
idinteger · int32Required

The ID of a session server for which to modify the Criteria settings.

Body

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

accountstring | nullableOptional

The name of the account to remove from the Criteria.

sidstring | nullableOptional

The SID of the account to remove from the Criteria.

Responses
delete
DELETE /api/MFA/{id}/Criteria/SecurityPrincipals HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

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

No content

Last updated

Was this helpful?