LegacyUserSelfService
Realm Operations
Resource path:
/realm-config/services/security
Resource version: 1.0
create
Usage
am> create LegacyUserSelfService --realm Realm --body body
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "confirmationIdHmacKey" : { "title" : "Confirmation Id HMAC Signing Key", "description" : "256-bit key (base64-encoded) to use for HMAC signing of the legacy self-service confirmation email links.", "propertyOrder" : 1000, "required" : true, "type" : "string", "exampleValue" : "" }, "forgotPasswordTokenLifetime" : { "title" : "Forgot Password Token Lifetime (seconds)", "description" : "Maximum life time for the token that allows a user to process a forgotten password using the REST API.", "propertyOrder" : 600, "required" : true, "type" : "integer", "exampleValue" : "" }, "selfServiceEnabled" : { "title" : "Legacy Self-Service REST Endpoint", "description" : "Specify whether to enable the legacy self-service endpoint.<p>OpenAM supports two User Self-Service components: the Legacy User Self-Service, which is based on a Java SDK and is available in OpenAM versions prior to OpenAM 13, and a common REST-based/XUI-based User Self-Service available in OpenAM 13 and later.<p>The Legacy User Self-Service will be deprecated in a future release.", "propertyOrder" : 100, "required" : true, "type" : "boolean", "exampleValue" : "" }, "selfRegistrationConfirmationUrl" : { "title" : "Self-Registration Confirmation Email URL", "description" : "This page handles the HTTP GET request when the user clicks the link sent by email in the confirmation request.", "propertyOrder" : 400, "required" : true, "type" : "string", "exampleValue" : "" }, "selfRegistrationEnabled" : { "title" : "Self-Registration for Users", "description" : "If enabled, new users can sign up using a REST API client.", "propertyOrder" : 200, "required" : true, "type" : "boolean", "exampleValue" : "" }, "forgotPasswordEnabled" : { "title" : "Forgot Password for Users", "description" : "If enabled, users can assign themselves a new password using a REST API client.", "propertyOrder" : 500, "required" : true, "type" : "boolean", "exampleValue" : "" }, "forgotPasswordConfirmationUrl" : { "title" : "Forgot Password Confirmation Email URL", "description" : "This page handles the HTTP GET request when the user clicks the link sent by email in the confirmation request.", "propertyOrder" : 700, "required" : true, "type" : "string", "exampleValue" : "" }, "userRegisteredDestination" : { "title" : "Destination After Successful Self-Registration", "description" : "Specifies the behavior when self-registration has successfully completed.", "propertyOrder" : 800, "required" : true, "type" : "string", "exampleValue" : "" }, "protectedUserAttributes" : { "title" : "Protected User Attributes", "description" : "A list of user profile attributes. Users modifying any of the attributes in this list will be required to enter a password as confirmation before the change is accepted. This option applies to XUI deployments only.", "propertyOrder" : 900, "required" : true, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" }, "selfRegistrationTokenLifetime" : { "title" : "Self-Registration Token LifeTime (seconds)", "description" : "Maximum life time for the token allowing User Self-Registration using the REST API.", "propertyOrder" : 300, "required" : true, "type" : "integer", "exampleValue" : "" } } }
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action LegacyUserSelfService --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action LegacyUserSelfService --realm Realm --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action LegacyUserSelfService --realm Realm --actionName nextdescendents
update
Usage
am> update LegacyUserSelfService --realm Realm --body body
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "confirmationIdHmacKey" : { "title" : "Confirmation Id HMAC Signing Key", "description" : "256-bit key (base64-encoded) to use for HMAC signing of the legacy self-service confirmation email links.", "propertyOrder" : 1000, "required" : true, "type" : "string", "exampleValue" : "" }, "forgotPasswordTokenLifetime" : { "title" : "Forgot Password Token Lifetime (seconds)", "description" : "Maximum life time for the token that allows a user to process a forgotten password using the REST API.", "propertyOrder" : 600, "required" : true, "type" : "integer", "exampleValue" : "" }, "selfServiceEnabled" : { "title" : "Legacy Self-Service REST Endpoint", "description" : "Specify whether to enable the legacy self-service endpoint.<p>OpenAM supports two User Self-Service components: the Legacy User Self-Service, which is based on a Java SDK and is available in OpenAM versions prior to OpenAM 13, and a common REST-based/XUI-based User Self-Service available in OpenAM 13 and later.<p>The Legacy User Self-Service will be deprecated in a future release.", "propertyOrder" : 100, "required" : true, "type" : "boolean", "exampleValue" : "" }, "selfRegistrationConfirmationUrl" : { "title" : "Self-Registration Confirmation Email URL", "description" : "This page handles the HTTP GET request when the user clicks the link sent by email in the confirmation request.", "propertyOrder" : 400, "required" : true, "type" : "string", "exampleValue" : "" }, "selfRegistrationEnabled" : { "title" : "Self-Registration for Users", "description" : "If enabled, new users can sign up using a REST API client.", "propertyOrder" : 200, "required" : true, "type" : "boolean", "exampleValue" : "" }, "forgotPasswordEnabled" : { "title" : "Forgot Password for Users", "description" : "If enabled, users can assign themselves a new password using a REST API client.", "propertyOrder" : 500, "required" : true, "type" : "boolean", "exampleValue" : "" }, "forgotPasswordConfirmationUrl" : { "title" : "Forgot Password Confirmation Email URL", "description" : "This page handles the HTTP GET request when the user clicks the link sent by email in the confirmation request.", "propertyOrder" : 700, "required" : true, "type" : "string", "exampleValue" : "" }, "userRegisteredDestination" : { "title" : "Destination After Successful Self-Registration", "description" : "Specifies the behavior when self-registration has successfully completed.", "propertyOrder" : 800, "required" : true, "type" : "string", "exampleValue" : "" }, "protectedUserAttributes" : { "title" : "Protected User Attributes", "description" : "A list of user profile attributes. Users modifying any of the attributes in this list will be required to enter a password as confirmation before the change is accepted. This option applies to XUI deployments only.", "propertyOrder" : 900, "required" : true, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" }, "selfRegistrationTokenLifetime" : { "title" : "Self-Registration Token LifeTime (seconds)", "description" : "Maximum life time for the token allowing User Self-Registration using the REST API.", "propertyOrder" : 300, "required" : true, "type" : "integer", "exampleValue" : "" } } }
Global Operations
Resource path:
/global-config/services/security
Resource version: 1.0
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action LegacyUserSelfService --global --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action LegacyUserSelfService --global --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action LegacyUserSelfService --global --actionName nextdescendents
update
Usage
am> update LegacyUserSelfService --global --body body
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "defaults" : { "properties" : { "forgotPasswordTokenLifetime" : { "title" : "Forgot Password Token Lifetime (seconds)", "description" : "Maximum life time for the token that allows a user to process a forgotten password using the REST API.", "propertyOrder" : 600, "required" : true, "type" : "integer", "exampleValue" : "" }, "userRegisteredDestination" : { "title" : "Destination After Successful Self-Registration", "description" : "Specifies the behavior when self-registration has successfully completed.", "propertyOrder" : 800, "required" : true, "type" : "string", "exampleValue" : "" }, "selfRegistrationEnabled" : { "title" : "Self-Registration for Users", "description" : "If enabled, new users can sign up using a REST API client.", "propertyOrder" : 200, "required" : true, "type" : "boolean", "exampleValue" : "" }, "forgotPasswordEnabled" : { "title" : "Forgot Password for Users", "description" : "If enabled, users can assign themselves a new password using a REST API client.", "propertyOrder" : 500, "required" : true, "type" : "boolean", "exampleValue" : "" }, "selfRegistrationConfirmationUrl" : { "title" : "Self-Registration Confirmation Email URL", "description" : "This page handles the HTTP GET request when the user clicks the link sent by email in the confirmation request.", "propertyOrder" : 400, "required" : true, "type" : "string", "exampleValue" : "" }, "selfRegistrationTokenLifetime" : { "title" : "Self-Registration Token LifeTime (seconds)", "description" : "Maximum life time for the token allowing User Self-Registration using the REST API.", "propertyOrder" : 300, "required" : true, "type" : "integer", "exampleValue" : "" }, "forgotPasswordConfirmationUrl" : { "title" : "Forgot Password Confirmation Email URL", "description" : "This page handles the HTTP GET request when the user clicks the link sent by email in the confirmation request.", "propertyOrder" : 700, "required" : true, "type" : "string", "exampleValue" : "" }, "confirmationIdHmacKey" : { "title" : "Confirmation Id HMAC Signing Key", "description" : "256-bit key (base64-encoded) to use for HMAC signing of the legacy self-service confirmation email links.", "propertyOrder" : 1000, "required" : true, "type" : "string", "exampleValue" : "" }, "selfServiceEnabled" : { "title" : "Legacy Self-Service REST Endpoint", "description" : "Specify whether to enable the legacy self-service endpoint.<p>OpenAM supports two User Self-Service components: the Legacy User Self-Service, which is based on a Java SDK and is available in OpenAM versions prior to OpenAM 13, and a common REST-based/XUI-based User Self-Service available in OpenAM 13 and later.<p>The Legacy User Self-Service will be deprecated in a future release.", "propertyOrder" : 100, "required" : true, "type" : "boolean", "exampleValue" : "" }, "protectedUserAttributes" : { "title" : "Protected User Attributes", "description" : "A list of user profile attributes. Users modifying any of the attributes in this list will be required to enter a password as confirmation before the change is accepted. This option applies to XUI deployments only.", "propertyOrder" : 900, "required" : true, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" } }, "type" : "object", "title" : "Realm Defaults" } } }