( Return to API Overview )

Available methods

Description

If you are using IPA integration to allow authentication of users from an external IPA server (rare) the users will still need to be created in the Satellite database. Methods in this namespace allow you to configure some specifics of how this happens, like what organization they are created in or what roles they will have. These options can also be set in the web admin interface.

Namespace: user.external


Method: createExternalGroupToRoleMap

Description:
Externally authenticated users may be members of external groups. You can use these groups to assign additional roles to the users when they log in. Can only be called by a satellite_admin.

Parameters:

Returns:


Method: createExternalGroupToSystemGroupMap

Description:
Externally authenticated users may be members of external groups. You can use these groups to give access to server groups to the users when they log in. Can only be called by an org_admin.

Parameters:

Returns:


Method: deleteExternalGroupToRoleMap

Description:
Delete the role map for an external group. Can only be called by a satellite_admin.

Parameters:

Returns:


Method: deleteExternalGroupToSystemGroupMap

Description:
Delete the server group map for an external group. Can only be called by an org_admin.

Parameters:

Returns:


Method: getDefaultOrg

Description:
Get the default org that users should be added in if orgunit from IPA server isn't found or is disabled. Can only be called by a satellite_admin.

Parameters:

Returns:


Method: getExternalGroupToRoleMap

Description:
Get a representation of the role mapping for an external group. Can only be called by a satellite_admin.

Parameters:

Returns:


Method: getExternalGroupToSystemGroupMap

Description:
Get a representation of the server group mapping for an external group. Can only be called by an org_admin.

Parameters:

Returns:


Method: getKeepTemporaryRoles

Description:
Get whether we should keeps roles assigned to users because of their IPA groups even after they log in through a non-IPA method. Can only be called by a satellite_admin.

Parameters:

Returns:


Method: getUseOrgUnit

Description:
Get whether we place users into the organization that corresponds to the "orgunit" set on the IPA server. The orgunit name must match exactly the Satellite organization name. Can only be called by a satellite_admin.

Parameters:

Returns:


Method: listExternalGroupToRoleMaps

Description:
List role mappings for all known external groups. Can only be called by a satellite_admin.

Parameters:

Returns:


Method: listExternalGroupToSystemGroupMaps

Description:
List server group mappings for all known external groups. Can only be called by an org_admin.

Parameters:

Returns:


Method: setDefaultOrg

Description:
Set the default org that users should be added in if orgunit from IPA server isn't found or is disabled. Can only be called by a satellite_admin.

Parameters:

Returns:


Method: setExternalGroupRoles

Description:
Update the roles for an external group. Replace previously set roles with the ones passed in here. Can only be called by a satellite_admin.

Parameters:

Returns:


Method: setExternalGroupSystemGroups

Description:
Update the server groups for an external group. Replace previously set server groups with the ones passed in here. Can only be called by an org_admin.

Parameters:

Returns:


Method: setKeepTemporaryRoles

Description:
Set whether we should keeps roles assigned to users because of their IPA groups even after they log in through a non-IPA method. Can only be called by a satellite_admin.

Parameters:

Returns:


Method: setUseOrgUnit

Description:
Set whether we place users into the organization that corresponds to the "orgunit" set on the IPA server. The orgunit name must match exactly the Satellite organization name. Can only be called by a satellite_admin.

Parameters:

Returns:


Generated on 1/9/2019