Skip to main content

REST APIs for 24.2.20 and 24.2.10

Security Principals

Security principals are typically unique identifiers for Windows Advanced Directory groups, but they can also be unique identifiers for individuals. This Public Stable API allows you to get (one or many), create (one or bulk), update, and delete security principals.

An array of security principals HREFs can be passed into rules and rulesets in the consuming_security_principals array.

Note

The common schema consuming_security_principals has been replaced by two other APIs: consuming_security_principals_get and consuming_security_principals_put

Security Principals API Methods

Security Principals Methods

HTTP

URI

Get Security Principals

GET

[api_version][org_href]/security_principals/

Get a Security Principal

GET

[api_version][org_href]/security_principals/sid

Create a Security Principal

POST

[api_version][org_href]/security_principals/

Bulk create Security Principals

PUT

[api_version][org_href]/security_principals/bulk_create

Update a Security Principal

PUT

[api_version][org_href]/security_principals/sid

Delete a Security Principal

DELETE

[api_version][org_href]/security_principals/sid

Get Security Principals

This GET command, by default, returns information for 100 security principals if max_results is not specified.

A maximum value of up to 500 can be specified for max_results.

Update a Security Principal

Use a PUT command to update a security principal.

Bulk Create Security Principals

This PUT command creates multiple security principals.

A maximum of 2,000 security principals can be added to this API in a call. On success, this API returns an array containing the HREFs of the created security principals.