IdRepositoryUser
Global Operations
Resource path:
/global-config/services/id-repositories/user
Resource version: 1.0
create
Usage
am> create IdRepositoryUser --global --id id --body body
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "givenName" : { "title" : "First Name", "description" : "", "propertyOrder" : 9000, "required" : false, "type" : "string", "exampleValue" : "" }, "iplanet-am-user-success-url" : { "title" : "Success URL", "description" : "URL or ClientType|URL if client specific. URL without http(s) protocol will be appended to the current URI.", "propertyOrder" : 10200, "required" : false, "type" : "string", "exampleValue" : "" }, "userPassword" : { "title" : "Password", "description" : "", "propertyOrder" : 9400, "required" : true, "type" : "string", "format" : "password", "exampleValue" : "" }, "iplanet-am-user-auth-config" : { "title" : "Authentication Configuration", "description" : "", "propertyOrder" : 10000, "required" : true, "type" : "string", "exampleValue" : "" }, "sn" : { "title" : "Last Name", "description" : "", "propertyOrder" : 9100, "required" : false, "type" : "string", "exampleValue" : "" }, "iplanet-am-user-failure-url" : { "title" : "Failure URL", "description" : "URL or ClientType|URL if client specific. URL without http(s) protocol will be appended to the current URI.", "propertyOrder" : 10300, "required" : false, "type" : "string", "exampleValue" : "" }, "postalAddress" : { "title" : "Home Address", "description" : "", "propertyOrder" : 9800, "required" : false, "type" : "string", "exampleValue" : "" }, "dn" : { "title" : "DN", "description" : "", "propertyOrder" : 9300, "required" : false, "type" : "string", "exampleValue" : "" }, "employeeNumber" : { "title" : "Employee Number", "description" : "", "propertyOrder" : 9600, "required" : false, "type" : "string", "exampleValue" : "" }, "iplanet-am-user-alias-list" : { "title" : "User Alias List", "description" : "", "propertyOrder" : 10100, "required" : false, "type" : "string", "exampleValue" : "" }, "inetUserStatus" : { "title" : "User Status", "description" : "", "propertyOrder" : 9900, "required" : true, "type" : "string", "exampleValue" : "" }, "retryLimitNodeCount" : { "title" : "retryLimitNodeCount", "description" : "", "propertyOrder" : 9900, "required" : false, "type" : "string", "exampleValue" : "" }, "telephoneNumber" : { "title" : "Telephone Number", "description" : "", "propertyOrder" : 9700, "required" : false, "type" : "string", "exampleValue" : "" }, "sunIdentityMSISDNNumber" : { "title" : "MSISDN Number", "description" : "", "propertyOrder" : 10400, "required" : false, "type" : "string", "exampleValue" : "" }, "roles" : { "title" : "Roles", "description" : "", "propertyOrder" : 10500, "required" : false, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" }, "cn" : { "title" : "Full Name", "description" : "", "propertyOrder" : 9200, "required" : false, "type" : "string", "exampleValue" : "" }, "mail" : { "title" : "Email Address", "description" : "", "propertyOrder" : 9500, "required" : false, "type" : "string", "exampleValue" : "" }, "lastEmailSent" : { "title" : "lastEmailSent", "description" : "", "propertyOrder" : 9800, "required" : false, "type" : "string", "exampleValue" : "" } } }
delete
Usage
am> delete IdRepositoryUser --global --id id
Parameters
- --id
-
The unique identifier for the resource.
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action IdRepositoryUser --global --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action IdRepositoryUser --global --actionName getCreatableTypes
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action IdRepositoryUser --global --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query IdRepositoryUser --global --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read IdRepositoryUser --global --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update IdRepositoryUser --global --id id --body body
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "givenName" : { "title" : "First Name", "description" : "", "propertyOrder" : 9000, "required" : false, "type" : "string", "exampleValue" : "" }, "iplanet-am-user-success-url" : { "title" : "Success URL", "description" : "URL or ClientType|URL if client specific. URL without http(s) protocol will be appended to the current URI.", "propertyOrder" : 10200, "required" : false, "type" : "string", "exampleValue" : "" }, "userPassword" : { "title" : "Password", "description" : "", "propertyOrder" : 9400, "required" : true, "type" : "string", "format" : "password", "exampleValue" : "" }, "iplanet-am-user-auth-config" : { "title" : "Authentication Configuration", "description" : "", "propertyOrder" : 10000, "required" : true, "type" : "string", "exampleValue" : "" }, "sn" : { "title" : "Last Name", "description" : "", "propertyOrder" : 9100, "required" : false, "type" : "string", "exampleValue" : "" }, "iplanet-am-user-failure-url" : { "title" : "Failure URL", "description" : "URL or ClientType|URL if client specific. URL without http(s) protocol will be appended to the current URI.", "propertyOrder" : 10300, "required" : false, "type" : "string", "exampleValue" : "" }, "postalAddress" : { "title" : "Home Address", "description" : "", "propertyOrder" : 9800, "required" : false, "type" : "string", "exampleValue" : "" }, "dn" : { "title" : "DN", "description" : "", "propertyOrder" : 9300, "required" : false, "type" : "string", "exampleValue" : "" }, "employeeNumber" : { "title" : "Employee Number", "description" : "", "propertyOrder" : 9600, "required" : false, "type" : "string", "exampleValue" : "" }, "iplanet-am-user-alias-list" : { "title" : "User Alias List", "description" : "", "propertyOrder" : 10100, "required" : false, "type" : "string", "exampleValue" : "" }, "inetUserStatus" : { "title" : "User Status", "description" : "", "propertyOrder" : 9900, "required" : true, "type" : "string", "exampleValue" : "" }, "retryLimitNodeCount" : { "title" : "retryLimitNodeCount", "description" : "", "propertyOrder" : 9900, "required" : false, "type" : "string", "exampleValue" : "" }, "telephoneNumber" : { "title" : "Telephone Number", "description" : "", "propertyOrder" : 9700, "required" : false, "type" : "string", "exampleValue" : "" }, "sunIdentityMSISDNNumber" : { "title" : "MSISDN Number", "description" : "", "propertyOrder" : 10400, "required" : false, "type" : "string", "exampleValue" : "" }, "roles" : { "title" : "Roles", "description" : "", "propertyOrder" : 10500, "required" : false, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" }, "cn" : { "title" : "Full Name", "description" : "", "propertyOrder" : 9200, "required" : false, "type" : "string", "exampleValue" : "" }, "mail" : { "title" : "Email Address", "description" : "", "propertyOrder" : 9500, "required" : false, "type" : "string", "exampleValue" : "" }, "lastEmailSent" : { "title" : "lastEmailSent", "description" : "", "propertyOrder" : 9800, "required" : false, "type" : "string", "exampleValue" : "" } } }