Sign-On Policies Operations
The sign-on policies endpoints provide common operations to create and manage sign-on policies resources.
You need the Environment Admin role to perform operations on sign-on policy resources.
Sign-on policies data model
| Property | Type | Required | Mutable | Description |
|---|---|---|---|---|
|
Date |
N/A |
Read-only |
The time the resource was created. |
|
Boolean |
Required |
Mutable |
Indicates whether this sign-on policy is the environment’s default that is used by applications that do not have application-specific sign-on policy assignments. This property can only be set to |
|
String |
Optional |
Mutable |
The description of the sign-on policy. |
|
String |
Required |
Immutable |
The environment resource’s unique identifier associated with the sign-on policy. |
|
String |
N/A |
Read-only |
The sign-on policy resource’s unique identifier. |
|
String |
Required |
Mutable |
Rhe resource name. The name must be unique within the environment, and can consist of either a string of alphanumeric letters, underscore, hyphen, period: ^[a-zA-Z0-9_.-]+$ or an absolute URI if the string contains a ":" character. |
|
Date |
N/A |
Read-only |
The time the resource was last updated. |
Sign-on policies events generated
Refer to Audit Reporting Events for the events generated.
Sign-on policy errors
In addition to the general error codes, sign-on policy operations can return the following errors:
| HTTP status | Top‑level code | Detail code | When it happens and what the response contains |
|---|---|---|---|
400 |
|
|
Message: When and detailsWhen: A Details: Describes the failing property, such as |
400 |
|
|
Message: When and detailsWhen: A Details: |
400 |
|
|
Message: When and detailsWhen: A Details: Cannot delete the sign on policy because you have MFA disabled or no valid registered devices, and the remaining sign on policies for a platform application (or the default policy if none remain) require MFA. |
400 |
|
None |
Message: When and detailsWhen: A path identifier cannot be parsed as a UUID, or the request body cannot be deserialized Details: For a JSON field conversion error, the detail is |
403 |
|
None |
Message: When and detailsWhen: The actor lacks the Details: None. |
404 |
|
None |
Message: When and detailsWhen: Details: None. |