SessionUserService

Realm Operations

Resource path: /users/{user}/services/session

Resource version: 1.0

create

Usage:

am> create SessionUserService --realm Realm --body body

Parameters:

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "properties" : {
    "iplanet-am-session-quota-limit" : {
      "title" : "Active User Sessions",
      "description" : "Maximum number of concurrent CTS-based sessions OpenAM allows a user to have.",
      "propertyOrder" : 800,
      "required" : true,
      "type" : "integer",
      "exampleValue" : ""
    },
    "iplanet-am-session-max-caching-time" : {
      "title" : "Maximum Caching Time",
      "description" : "Maximum time that external clients of AM are recommended to cache the session for, in minutes.",
      "propertyOrder" : 300,
      "required" : true,
      "type" : "integer",
      "exampleValue" : ""
    },
    "iplanet-am-session-max-session-time" : {
      "title" : "Maximum Session Time",
      "description" : "Maximum time a session can remain valid before OpenAM requires the user to authenticate again, in minutes.",
      "propertyOrder" : 100,
      "required" : true,
      "type" : "integer",
      "exampleValue" : ""
    },
    "iplanet-am-session-max-idle-time" : {
      "title" : "Maximum Idle Time",
      "description" : "Maximum time a CTS-based session can remain idle before OpenAM requires the user to authenticate again, in minutes.",
      "propertyOrder" : 200,
      "required" : true,
      "type" : "integer",
      "exampleValue" : ""
    }
  }
}

delete

Usage:

am> delete SessionUserService --realm Realm

getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

Usage:

am> action SessionUserService --realm Realm --user user --actionName getAllTypes

Parameters:

--user

getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

Usage:

am> action SessionUserService --realm Realm --user user --actionName getCreatableTypes

Parameters:

--user

nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

Usage:

am> action SessionUserService --realm Realm --user user --actionName nextdescendents

Parameters:

--user

read

Usage:

am> read SessionUserService --realm Realm

unassignServices

action.unassignServices.description

Usage:

am> action SessionUserService --realm Realm --body body --user user --actionName unassignServices

Parameters:

--body

The resource in JSON format, described by the following JSON schema:

{
  "description" : "i18n:api-descriptor/UserServicesResource#schema.description",
  "type" : "object",
  "title" : "i18n:api-descriptor/UserServicesResource#schema.title",
  "properties" : {
    "serviceNames" : {
      "type" : "array",
      "title" : "i18n:api-descriptor/UserServicesResource#schema.servicename.title",
      "description" : "i18n:api-descriptor/UserServicesResource#schema.servicename.description",
      "items" : {
        "type" : "string"
      }
    }
  }
}

--user

update

Usage:

am> update SessionUserService --realm Realm --body body

Parameters:

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "properties" : {
    "iplanet-am-session-quota-limit" : {
      "title" : "Active User Sessions",
      "description" : "Maximum number of concurrent CTS-based sessions OpenAM allows a user to have.",
      "propertyOrder" : 800,
      "required" : true,
      "type" : "integer",
      "exampleValue" : ""
    },
    "iplanet-am-session-max-caching-time" : {
      "title" : "Maximum Caching Time",
      "description" : "Maximum time that external clients of AM are recommended to cache the session for, in minutes.",
      "propertyOrder" : 300,
      "required" : true,
      "type" : "integer",
      "exampleValue" : ""
    },
    "iplanet-am-session-max-session-time" : {
      "title" : "Maximum Session Time",
      "description" : "Maximum time a session can remain valid before OpenAM requires the user to authenticate again, in minutes.",
      "propertyOrder" : 100,
      "required" : true,
      "type" : "integer",
      "exampleValue" : ""
    },
    "iplanet-am-session-max-idle-time" : {
      "title" : "Maximum Idle Time",
      "description" : "Maximum time a CTS-based session can remain idle before OpenAM requires the user to authenticate again, in minutes.",
      "propertyOrder" : 200,
      "required" : true,
      "type" : "integer",
      "exampleValue" : ""
    }
  }
}