org

Available methods

Description

Contains methods to access common organization management functions available from the web interface.

Namespace:

org

Method: create

HTTP POST

Description:

Create a new organization and associated administrator account.

Parameters:

  • string sessionKey

  • string orgName - Organization name. Must meet same criteria as in the web UI.

  • string adminLogin - New administrator login name.

  • string adminPassword - New administrator password.

  • string prefix - New administrator’s prefix. Must match one of the values available in the web UI. (i.e. Dr., Mr., Mrs., Sr., etc.)

  • string firstName - New administrator’s first name.

  • string lastName - New administrator’s first name.

  • string email - New administrator’s e-mail.

  • boolean usePamAuth - True if PAM authentication should be used for the new administrator account.

Returns:

  • * struct organization info

    • int "id"

    • string "name"

    • int "active_users" - number of active users in the organization

    • int "systems" - number of systems in the organization

    • int "trusts" - number of trusted organizations

    • int "system_groups" - number of system groups in the organization (optional)

    • int "activation_keys" - number of activation keys in the organization (optional)

    • int "kickstart_profiles" - number of kickstart profiles in the organization (optional)

    • int "configuration_channels" - number of configuration channels in the organization (optional)

    • boolean "staging_content_enabled" - is staging content enabled in organization (optional)

Method: createFirst

HTTP POST

Description:

Create first organization and user after initial setup without authentication

Parameters:

  • string orgName - Organization name. Must meet same criteria as in the web UI.

  • string adminLogin - New administrator login name.

  • string adminPassword - New administrator password.

  • string firstName - New administrator’s first name.

  • string lastName - New administrator’s first name.

  • string email - New administrator’s e-mail.

Returns:

  • * struct organization info

    • int "id"

    • string "name"

    • int "active_users" - number of active users in the organization

    • int "systems" - number of systems in the organization

    • int "trusts" - number of trusted organizations

    • int "system_groups" - number of system groups in the organization (optional)

    • int "activation_keys" - number of activation keys in the organization (optional)

    • int "kickstart_profiles" - number of kickstart profiles in the organization (optional)

    • int "configuration_channels" - number of configuration channels in the organization (optional)

    • boolean "staging_content_enabled" - is staging content enabled in organization (optional)

Method: delete

HTTP POST

Description:

Delete an organization. The default organization (i.e. orgId=1) cannot be deleted.

Parameters:

  • string sessionKey

  • int orgId

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: getClmSyncPatchesConfig

HTTP GET

Description:

Reads the content lifecycle management patch synchronization config option.

Parameters:

  • string sessionKey

  • int orgId

Returns:

  • boolean status - Get the config option value

Method: getDetails

HTTP GET

Description:

The detailed information about an organization given the organization ID.

Parameters:

  • string sessionKey

  • int orgId

Returns:

  • * struct organization info

    • int "id"

    • string "name"

    • int "active_users" - number of active users in the organization

    • int "systems" - number of systems in the organization

    • int "trusts" - number of trusted organizations

    • int "system_groups" - number of system groups in the organization (optional)

    • int "activation_keys" - number of activation keys in the organization (optional)

    • int "kickstart_profiles" - number of kickstart profiles in the organization (optional)

    • int "configuration_channels" - number of configuration channels in the organization (optional)

    • boolean "staging_content_enabled" - is staging content enabled in organization (optional)

Method: getDetails

HTTP GET

Description:

The detailed information about an organization given the organization name.

Parameters:

  • string sessionKey

  • string name

Returns:

  • * struct organization info

    • int "id"

    • string "name"

    • int "active_users" - number of active users in the organization

    • int "systems" - number of systems in the organization

    • int "trusts" - number of trusted organizations

    • int "system_groups" - number of system groups in the organization (optional)

    • int "activation_keys" - number of activation keys in the organization (optional)

    • int "kickstart_profiles" - number of kickstart profiles in the organization (optional)

    • int "configuration_channels" - number of configuration channels in the organization (optional)

    • boolean "staging_content_enabled" - is staging content enabled in organization (optional)

Method: getPolicyForScapFileUpload

HTTP GET

Description:

Get the status of SCAP detailed result file upload settings for the given organization.

Parameters:

  • string sessionKey

  • int orgId

Returns:

  • struct scap_upload_info

    • boolean "enabled" - Aggregation of detailed SCAP results is enabled.

    • int "size_limit" - Limit (in Bytes) for a single SCAP file upload.

Method: getPolicyForScapResultDeletion

HTTP GET

Description:

Get the status of SCAP result deletion settings for the given organization.

Parameters:

  • string sessionKey

  • int orgId

Returns:

  • struct scap_deletion_info

    • boolean "enabled" - Deletion of SCAP results is enabled

    • int "retention_period" - Period (in days) after which a scan can be deleted (if enabled).

Method: isContentStagingEnabled

HTTP GET

Description:

Get the status of content staging settings for the given organization. Returns true if enabled, false otherwise.

Parameters:

  • string sessionKey

  • int orgId

Returns:

  • boolean status - Get the status of content staging settings

Method: isErrataEmailNotifsForOrg

HTTP GET

Description:

Returns whether errata e-mail notifications are enabled for the organization

Parameters:

  • string sessionKey

  • int orgId

Returns:

  • boolean status - Returns the status of the errata e-mail notification setting for the organization

Method: isOrgConfigManagedByOrgAdmin

HTTP GET

Description:

Returns whether Organization Administrator is able to manage his organization configuration. This may have a high impact on general #product() performance.

Parameters:

  • string sessionKey

  • int orgId

Returns:

  • boolean status - Returns the status org admin management setting

Method: listOrgs

HTTP GET

Description:

Returns the list of organizations.

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct organization info

    • int "id"

    • string "name"

    • int "active_users" - number of active users in the organization

    • int "systems" - number of systems in the organization

    • int "trusts" - number of trusted organizations

    • int "system_groups" - number of system groups in the organization (optional)

    • int "activation_keys" - number of activation keys in the organization (optional)

    • int "kickstart_profiles" - number of kickstart profiles in the organization (optional)

    • int "configuration_channels" - number of configuration channels in the organization (optional)

    • boolean "staging_content_enabled" - is staging content enabled in organization (optional)

Method: listUsers

HTTP GET

Description:

Returns the list of users in a given organization.

Parameters:

  • string sessionKey

  • int orgId

Returns:

  • array :

  • struct user

    • string "login"

    • string "login_uc"

    • string "name"

    • string "email"

    • boolean "is_org_admin"

Method: migrateSystems (Deprecated)

HTTP POST

Description:

Transfer systems from one organization to another. If executed by a #product() administrator, the systems will be transferred from their current organization to the organization specified by the toOrgId. If executed by an organization administrator, the systems must exist in the same organization as that administrator and the systems will be transferred to the organization specified by the toOrgId. In any scenario, the origination and destination organizations must be defined in a trust.

Note: This method is deprecated and will be removed in a future API version. Please use
transferSystems instead.

Deprecated - being replaced by org.transferSystems(User loggedInUser, Integer toOrgId, List(Integer) sids)

Parameters:

  • string sessionKey

  • int toOrgId - ID of the organization where the system(s) will be transferred to.

  • int array sids

Returns:

  • int array serverIdTransferred

Method: setClmSyncPatchesConfig

HTTP POST

Description:

Sets the content lifecycle management patch synchronization config option.

Parameters:

  • string sessionKey

  • int orgId

  • boolean value - The config option value

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setContentStaging

HTTP POST

Description:

Set the status of content staging for the given organization.

Parameters:

  • string sessionKey

  • int orgId

  • boolean enable - Use true/false to enable/disable

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setErrataEmailNotifsForOrg

HTTP POST

Description:

Dis/enables errata e-mail notifications for the organization

Parameters:

  • string sessionKey

  • int orgId

  • boolean enable - Use true/false to enable/disable

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setOrgConfigManagedByOrgAdmin

HTTP POST

Description:

Sets whether Organization Administrator can manage his organization configuration. This may have a high impact on general #product() performance.

Parameters:

  • string sessionKey

  • int orgId

  • boolean enable - Use true/false to enable/disable

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setPolicyForScapFileUpload

HTTP POST

Description:

Set the status of SCAP detailed result file upload settings for the given organization.

Parameters:

  • string sessionKey

  • int orgId

  • struct newSettings

    • boolean "enabled" - Aggregation of detailed SCAP results is enabled.

    • int "size_limit" - Limit (in Bytes) for a single SCAP file upload.

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: setPolicyForScapResultDeletion

HTTP POST

Description:

Set the status of SCAP result deletion settins for the given organization.

Parameters:

  • string sessionKey

  • int orgId

  • struct newSettings

    • boolean "enabled" - Deletion of SCAP results is enabled

    • int "retention_period" - Period (in days) after which a scan can be deleted (if enabled).

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: transferSystems

HTTP POST

Description:

Transfer systems from one organization to another. If executed by a #product() administrator, the systems will be transferred from their current organization to the organization specified by the toOrgId. If executed by an organization administrator, the systems must exist in the same organization as that administrator and the systems will be transferred to the organization specified by the toOrgId. In any scenario, the origination and destination organizations must be defined in a trust.

Parameters:

  • string sessionKey

  • int toOrgId - ID of the organization where the system(s) will be transferred to.

  • int array sids

Returns:

  • int array serverIdTransferred

Method: updateName

HTTP POST

Description:

Updates the name of an organization

Parameters:

  • string sessionKey

  • int orgId

  • string name - Organization name. Must meet same criteria as in the web UI.

Returns:

  • * struct organization info

    • int "id"

    • string "name"

    • int "active_users" - number of active users in the organization

    • int "systems" - number of systems in the organization

    • int "trusts" - number of trusted organizations

    • int "system_groups" - number of system groups in the organization (optional)

    • int "activation_keys" - number of activation keys in the organization (optional)

    • int "kickstart_profiles" - number of kickstart profiles in the organization (optional)

    • int "configuration_channels" - number of configuration channels in the organization (optional)

    • boolean "staging_content_enabled" - is staging content enabled in organization (optional)