com.netegrity.llsdk6.imsapi.provider
Interface OrganizationProvider

public interface OrganizationProvider

Lets you create or retrieve organization objects in the current Identity Manager environment.

This and all Identity Manager providers are retrieved through ProviderAccessor.

Access to Organization Objects

This interface provides two ways of accessing organization objects:

• Hierarchical access, using specialized forms of the Organization object's generic methods to access the organizations within an organizational hierarchy.
• Environment-wide access, using methods that access all the organizations in the current Identity Manager environment.

Object Attributes and Attribute Permissions

You can specify the attributes to include in the retrieved objects. You do so through overloaded methods that let you choose between the following:

• Passing in just the names of the attributes to include. These attributes become part of a returned object's internal structure. Permissions associated with the attributes are not included.
• Passing in the names of the attributes and a permission request for each attribute. Attribute names and permission requests are passed in AttributeRightsCollection. The managed objects that are returned to the method include the specified attributes and their applicable permissions, as described below.

Access to Organization Attribute Data

After you retrieve an organization object, you access its attribute data through the methods in AttributeCollection.

Typically, managed objects retrieved through OrganizationProvider are accessed for reading purposes only. However, on occassion, business logic task handlers and event listeners may need to modify objects retrieved through OrganizationProvider.

Note: To commit the changes you make to a managed object retrieved through OrganizationProvider, call modifyObject(). The changes are then immediately persisted to the data store. No Identity Manager events are generated, and no workflow approvals, auditing, or security checks are performed.

Since:

IdentityMinder 6.0

Method Summary

Organization	createOrg(Organization org, java.util.Hashtable attribs) Create a new Organization within the specified Organization.
Organization	createOrg(Organization org, java.util.Hashtable attribs, AttributeRightsCollection permissions) Creates an organization object within the specified organization, including permission requests for the object's attributes.
Organization	findOrg(java.lang.String name, java.util.Enumeration attribs) Retrieves the specified organization object and attributes from the current Identity Manager environment.
Organization	findOrg(TSContext context, java.lang.String name, AttributeRightsCollection attribs) Retrieves the specified organization object and attributes from the current Identity Manager environment, and includes permissions for the specified attributes.
java.util.Vector	findOrgs(OrgFilter of, OrgMembershipConstraint orgs, AttributeRightsCollection attrs) Retrieves the organizations that match the specified attribute filter and organization membership constraint.
java.util.Vector	findOrgs(TSContext tsCtx, OrgFilter of, OrgScopeConstraint orgs, AttributeRightsCollection attrs) Retrieves the organizations within the current task that match the specified attribute filter and organization scope constraint.
java.util.Vector	findOrgs(TSContext tsCtx, OrgFilter of, OrgScopeConstraint orgs, OrgScopeConstraint orgs2, AttributeRightsCollection attrs) Retrieves the organizations within the current task that match the specified attribute filter and both sets of organization scope constraints.
java.util.Vector	findOrgsInScope(TSContext tsCtx, OrgFilter of, OrgScopeConstraint orgs, AttributeRightsCollection attrs) Retrieves the organizations within the current task that match the specified search criteria.
java.util.Vector	findOrgsInScope(TSContext tsCtx, OrgFilter of, OrgScopeConstraint orgs, AttributeRightsCollection attrs, ObjectType scopingType) Deprecated. Deprecated in Identity Manager 8.1. Use findOrgsInScope(), which omits scopingType.
java.util.Vector	getOrgChain(Organization org, java.util.Enumeration attributes) Retrieves a branch of the organization hierarchy that begins at the root organization and extends downward to and including the specified parameter.
java.util.Vector	getOrgChain(TSContext context, Organization org, AttributeRightsCollection attributes) Retrieves a branch of the organization hierarchy that begins at the root organization and extends downward to and including the specified parameter -- attribute permissions are included in the returned objects.
java.util.Vector	getOrgsInOrg(Organization org, SearchDepthType searchDepth, java.util.Enumeration attributes) Return all organizations in the specified organization(s).
java.util.Vector	getOrgsInOrg(TSContext context, Organization org, SearchDepthType searchDepth, AttributeRightsCollection attributes) Retrieves all organization objects in the specified organization(s) -- attribute permissions are included in the returned objects.
ApiResultSet	pagedGetOrgsInOrg(Organization org, SearchDepthType searchDepth, java.util.Enumeration attributes, SearchCursor cursor) Deprecated. As of FW 2.0, no alternate method exists. Retrieves and sorts all organization objects in the specified organization(s). This method is a specialization of Organization.getMembers(ObjectType, SearchDepthType) that handles scoping.
ApiResultSet	pagedGetOrgsInOrg(TSContext context, Organization org, SearchDepthType searchDepth, AttributeRightsCollection attributes, SearchCursor cursor) Deprecated. As of FW 2.0, no alternate method exists. Retrieves and sorts all organization objects in the specified organization(s) -- attribute permissions are included in the returned objects. This method is a specialization of Organization.getMembers(ObjectType, SearchDepthType) that handles scoping.
ApiResultSet	pagedSearchOrgForOrgs(Organization org, java.util.Vector filter, ConjunctionType conj, SearchDepthType searchDepth, java.util.Enumeration attributes, SearchCursor cursor) Deprecated. As of FW 2.0, no alternate method exists. Searches for organizations within the specified organization(s) and sorts the result. This method is a specialization of Organization.searchManagedObjects().
ApiResultSet	pagedSearchOrgForOrgs(Organization org, java.util.Vector filter, SearchDepthType searchDepth, java.util.Enumeration attributes, SearchCursor cursor) Deprecated. Deprecated in IdentityMinder 6.0. Use pagedSearchOrgForOrgs() containing ConjunctionType.
ApiResultSet	pagedSearchOrgForOrgs(TSContext context, Organization org, java.util.Vector filter, ConjunctionType conj, SearchDepthType searchDepth, AttributeRightsCollection attributes, SearchCursor cursor) Deprecated. As of FW 2.0, no alternate method exists. Searches for organizations within the specified organization(s) and sorts the result -- attribute permissions are included in the returned objects. This method is a specialization of Organization.searchManagedObjects().
java.util.Vector	searchOrgForOrgs(Organization org, java.util.Vector filter, ConjunctionType conj, SearchDepthType searchDepth, java.util.Enumeration attributes) Searches for organizations within the specified organization(s).
java.util.Vector	searchOrgForOrgs(Organization org, java.util.Vector filter, SearchDepthType searchDepth, java.util.Enumeration attributes) Deprecated. Deprecated in IdentityMinder 6.0. Use searchOrgForOrgs() containing ConjunctionType.
java.util.Vector	searchOrgForOrgs(TSContext context, Organization org, java.util.Vector filter, ConjunctionType conj, SearchDepthType searchDepth, AttributeRightsCollection attributes) Searches for organizations within the specified organization(s) -- attribute permissions are included in the returned objects.

Method Detail

findOrg

Organization findOrg(java.lang.String name,
                     java.util.Enumeration attribs)
                     throws SmApiException,
                            NoSuchObjectException

Retrieves the specified organization object and attributes from the current Identity Manager environment.

Parameters:

name - The name of the organization to retrieve. The name can be a unique name or a friendly name.

attribs - An Enumeration of Strings containing names of the attributes to include in the retrieved object. If you pass an empty Enumeration, no attributes are included. If you pass null, all attributes are included.

Returns:

The specfied organization object, if found, containing the attributes specified in attribs.

Throws:

NoSuchObjectException - if the object cannot be found.

SmApiException

findOrg

Organization findOrg(TSContext context,
                     java.lang.String name,
                     AttributeRightsCollection attribs)
                     throws SmApiException,
                            NoSuchObjectException

Retrieves the specified organization object and attributes from the current Identity Manager environment, and includes permissions for the specified attributes.

Parameters:

context - Context information for the current task session.

name - The name of the organization to retrieve. The name can be a unique name or a friendly name.

attribs - A collection of AttributeRight objects, each containing an attribute name and a permission request.

Returns:

The specfied organization object, if found, containing the attributes specified in attribs and the associated permissions.

Throws:

NoSuchObjectException - if the object cannot be found.

SmApiException

findOrgs

java.util.Vector findOrgs(OrgFilter of,
                          OrgMembershipConstraint orgs,
                          AttributeRightsCollection attrs)
                          throws SmApiException

Retrieves the organizations that match the specified attribute filter and organization membership constraint.

Parameters:

of - The attribute filter for the search. If no filter is specified, all organizations in the specified membership constraint will be returned.

orgs - Organization constraint that defines the scope for the search. If no constraint is specified, the search will occur within all organizations.

attrs - A collection of AttributeRight objects, each containing an attribute name and a permission request.

Returns:

A Vector of organization objects containing the attributes specified in attrs and the associated permissions.

Throws:

SmApiException

findOrgs

java.util.Vector findOrgs(TSContext tsCtx,
                          OrgFilter of,
                          OrgScopeConstraint orgs,
                          AttributeRightsCollection attrs)
                          throws SmApiException

Retrieves the organizations within the current task that match the specified attribute filter and organization scope constraint.

Parameters:

tsCtx - The context within which organization scope constraints are evaluated.

of - The attribute filter for the search. If no filter is specified, all organizations in the specified organization scope will be returned.

orgs - The organization scope to search. If no constraint is specified, the search will occur within all organizations in the task context

attrs - A collection of AttributeRight objects, each containing an attribute name and a permission request.

Returns:

A Vector of organization objects containing the attributes specified in attrs and the associated permissions.

Throws:

SmApiException

findOrgs

java.util.Vector findOrgs(TSContext tsCtx,
                          OrgFilter of,
                          OrgScopeConstraint orgs,
                          OrgScopeConstraint orgs2,
                          AttributeRightsCollection attrs)
                          throws SmApiException

Retrieves the organizations within the current task that match the specified attribute filter and both sets of organization scope constraints.

The returned organizations must match the filter AND the first organization constraint AND the second organization constraint.

Parameters:

tsCtx - The context within which organization scope constraints are evaluated.

of - The attribute filter for the search. If no filter is specified, all organizations within the specified organization scopes will be returned.

orgs - The first organization scope to search. If no constraint is specified, the search will occur within all organizations in the task context.

orgs2 - The second organization scope to search. If no constraint is specified, the search will occur within the scope specified in orgs.

attrs - A collection of AttributeRight objects, each containing an attribute name and a permission request.

Returns:

A Vector of organization objects containing the attributes specified in attrs and the associated permissions.

Throws:

com.netegrity.sdk.apiutil.SmApiException

SmApiException

createOrg

Organization createOrg(Organization org,
                       java.util.Hashtable attribs)
                       throws SmApiException

Create a new Organization within the specified Organization.

This method is a specialization of Organization.createManagedObject().

Parameters:

org - The organization where the organization is being created.

attribs - Seed attributes to include in the organization object.

Returns:

The new organization object.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - if the org parameter is an Organization object that has already been deleted.

SmApiException

createOrg

Organization createOrg(Organization org,
                       java.util.Hashtable attribs,
                       AttributeRightsCollection permissions)
                       throws SmApiException

Creates an organization object within the specified organization, including permission requests for the object's attributes.

This method is a specialization of Organization.createManagedObject().

Parameters:

org - The organization where the organization is being created.

attribs - Seed attributes to include in the organization object.

permissions - A collection of AttributeRight objects, each containing an attribute name and a permission request.

Returns:

The new organization object.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - if the org parameter is an Organization object that has already been deleted.

SmApiException

getOrgsInOrg

java.util.Vector getOrgsInOrg(Organization org,
                              SearchDepthType searchDepth,
                              java.util.Enumeration attributes)
                              throws SmApiException

Return all organizations in the specified organization(s).

This method is a specialization of Organization.getMembers(ObjectType, SearchDepthType) that handles scoping.

Parameters:

org - The organization to search.

searchDepth - Indicates whether to search just the specified organization or also its children.

attributes - An Enumeration of Strings that specifies the attributes to include in retrieved objects. If you pass an empty Enumeration, no attributes are included. If you pass null, all attributes are included.

Returns:

A Vector of organization objects in the specified organization(s), each containing the attributes specified in attributes.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - if the org parameter is an Organization object that has already been deleted.

SmApiException

getOrgsInOrg

java.util.Vector getOrgsInOrg(TSContext context,
                              Organization org,
                              SearchDepthType searchDepth,
                              AttributeRightsCollection attributes)
                              throws SmApiException

Retrieves all organization objects in the specified organization(s) -- attribute permissions are included in the returned objects.

This method is a specialization of Organization.getMembers(ObjectType, SearchDepthType) that handles scoping.

Parameters:

context - Context information for the current task session.

org - The organization to search.

searchDepth - Indicates whether to search just the specified organization or also its children.

attributes - A collection of AttributeRight objects, each containing an attribute name and a permission request.

Returns:

A Vector of organization objects in the specified organization(s), each containing the attributes specified in attributes and the associated permissions.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - if the org parameter is an Organization object that has already been deleted.

SmApiException

pagedGetOrgsInOrg

ApiResultSet pagedGetOrgsInOrg(Organization org,
                               SearchDepthType searchDepth,
                               java.util.Enumeration attributes,
                               SearchCursor cursor)
                               throws SmApiException

Deprecated. As of FW 2.0, no alternate method exists.

Retrieves and sorts all organization objects in the specified organization(s).

This method is a specialization of Organization.getMembers(ObjectType, SearchDepthType) that handles scoping.

Parameters:

org - The organization to search.

searchDepth - Indicates whether to search just the specified organization or also its children.

attributes - An Enumeration of Strings that specifies the attributes to include in retrieved objects. If you pass an empty Enumeration, no attributes are included. If you pass null, all attributes are included.

cursor - Instructions for sorting the retrieved objects.

Returns:

The sorted organization objects retrieved from the specified organization(s), each containing the attributes specified in attributes.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - if the org parameter is an Organization object that has already been deleted.

SmApiException

pagedGetOrgsInOrg

ApiResultSet pagedGetOrgsInOrg(TSContext context,
                               Organization org,
                               SearchDepthType searchDepth,
                               AttributeRightsCollection attributes,
                               SearchCursor cursor)
                               throws SmApiException

Deprecated. As of FW 2.0, no alternate method exists.

Retrieves and sorts all organization objects in the specified organization(s) -- attribute permissions are included in the returned objects.

This method is a specialization of Organization.getMembers(ObjectType, SearchDepthType) that handles scoping.

Parameters:

context - Context information for the current task session.

org - The organization to search.

searchDepth - Indicates whether to search just the specified organization or also its children.

attributes - A collection of AttributeRight objects, each containing an attribute name and a permission request.

cursor - Instructions for sorting the retrieved objects.

Returns:

The sorted organization objects in the specified organization(s), each containing the attributes specified in attributes and the associated permissions.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - if the org parameter is an Organization object that has already been deleted.

SmApiException

searchOrgForOrgs

java.util.Vector searchOrgForOrgs(Organization org,
                                  java.util.Vector filter,
                                  SearchDepthType searchDepth,
                                  java.util.Enumeration attributes)
                                  throws SmApiException

Deprecated. Deprecated in IdentityMinder 6.0. Use searchOrgForOrgs() containing ConjunctionType.

Searches for organizations within the specified organization(s).

This method is a specialization of Organization.searchManagedObjects().

Parameters:

org - The organization to search.

filter - A Vector of SearchExpression objects that must all match the returned objects (all SearchExpression objects in the Vector are ANDed). If there is anything else in the Vector, an exception is thrown.

searchDepth - Indicates whether to search just the specified organization or also its children.

attributes - An Enumeration of Strings that specifies the attributes to include in retrieved objects. If you pass an empty Enumeration, no attributes are included. If you pass null, all attributes are included.

Returns:

A Vector of the organizations found in the search.

Throws:

SmApiException

searchOrgForOrgs

java.util.Vector searchOrgForOrgs(Organization org,
                                  java.util.Vector filter,
                                  ConjunctionType conj,
                                  SearchDepthType searchDepth,
                                  java.util.Enumeration attributes)
                                  throws SmApiException

Searches for organizations within the specified organization(s).

This method is a specialization of Organization.searchManagedObjects().

Parameters:

org - The organization to search.

filter - A Vector of SearchExpression objects. If there is anything else in the Vector, an exception is thrown.

conj - A conjunction (such as AND or OR) for combining expressions in the search filter.

searchDepth - Indicates whether to search just the specified organization or also its children.

attributes - An Enumeration of Strings that specifies the attributes to include in retrieved objects. If you pass an empty Enumeration, no attributes are included. If you pass null, all attributes are included.

Returns:

A Vector of the organizations found in the search.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - if the org parameter is an Organization object that has already been deleted.

SmApiException

searchOrgForOrgs

java.util.Vector searchOrgForOrgs(TSContext context,
                                  Organization org,
                                  java.util.Vector filter,
                                  ConjunctionType conj,
                                  SearchDepthType searchDepth,
                                  AttributeRightsCollection attributes)
                                  throws SmApiException

Searches for organizations within the specified organization(s) -- attribute permissions are included in the returned objects.

This method is a specialization of Organization.searchManagedObjects().

Parameters:

context - Context information for the current task session.

org - The organization to search.

filter - A Vector of SearchExpression objects. If there is anything else in the Vector, an exception is thrown.

conj - A conjunction (such as AND or OR) for combining expressions in the search filter.

searchDepth - Indicates whether to search just the specified organization or also its children.

attributes - A collection of AttributeRight objects, each containing an attribute name and a permission request.

Returns:

A Vector of the organizations found in the search, with attribute permissions included.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - if the org parameter is an Organization object that has already been deleted.

SmApiException

pagedSearchOrgForOrgs

ApiResultSet pagedSearchOrgForOrgs(Organization org,
                                   java.util.Vector filter,
                                   SearchDepthType searchDepth,
                                   java.util.Enumeration attributes,
                                   SearchCursor cursor)
                                   throws SmApiException

Deprecated. Deprecated in IdentityMinder 6.0. Use pagedSearchOrgForOrgs() containing ConjunctionType.

Searches for organizations within the specified organization(s) and sorts the result.

This method is a specialization of Organization.searchManagedObjects().

Parameters:

org - The organization to search.

filter - A Vector of SearchExpression objects that must all match the returned objects (all SearchExpression objects in the Vector are ANDed). If there is anything else in the Vector, an exception is thrown.

searchDepth - Indicates whether to search just the specified organization or also its children.

attributes - An Enumeration of Strings that specifies the attributes to include in retrieved objects. If you pass an empty Enumeration, no attributes are included. If you pass null, all attributes are included.

cursor - Instructions for sorting the retrieved objects.

Returns:

The sorted organization objects retrieved from the specified organization(s), each containing the attributes specified in attributes.

Throws:

SmApiException

pagedSearchOrgForOrgs

ApiResultSet pagedSearchOrgForOrgs(Organization org,
                                   java.util.Vector filter,
                                   ConjunctionType conj,
                                   SearchDepthType searchDepth,
                                   java.util.Enumeration attributes,
                                   SearchCursor cursor)
                                   throws SmApiException

Deprecated. As of FW 2.0, no alternate method exists.

Searches for organizations within the specified organization(s) and sorts the result.

This method is a specialization of Organization.searchManagedObjects().

Parameters:

org - The organization to search.

filter - A Vector of SearchExpression objects. If there is anything else in the Vector, an exception is thrown.

conj - A conjunction (such as AND or OR) for combining expressions in the search filter.

searchDepth - Indicates whether to search just the specified organization or also its children.

attributes - An Enumeration of Strings that specifies the attributes to include in retrieved objects. If you pass an empty Enumeration, no attributes are included. If you pass null, all attributes are included.

cursor - Instructions for sorting the retrieved objects.

Returns:

The sorted organization objects retrieved from the specified organization(s), each containing the attributes specified in attributes.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - if the org parameter is an Organization object that has already been deleted.

SmApiException

pagedSearchOrgForOrgs

ApiResultSet pagedSearchOrgForOrgs(TSContext context,
                                   Organization org,
                                   java.util.Vector filter,
                                   ConjunctionType conj,
                                   SearchDepthType searchDepth,
                                   AttributeRightsCollection attributes,
                                   SearchCursor cursor)
                                   throws SmApiException

Deprecated. As of FW 2.0, no alternate method exists.

Searches for organizations within the specified organization(s) and sorts the result -- attribute permissions are included in the returned objects.

This method is a specialization of Organization.searchManagedObjects().

Parameters:

context - Context information for the current task session.

org - The organization to search.

filter - A Vector of SearchExpression objects. If there is anything else in the Vector, an exception is thrown.

conj - A conjunction (such as AND or OR) for combining expressions in the search filter.

searchDepth - Indicates whether to search just the specified organization or also its children.

attributes - A collection of AttributeRight objects, each containing an attribute name and a permission request.

cursor - Instructions for sorting the retrieved objects.

Returns:

The sorted organization objects retrieved from the specified organization(s). The returned objects contain the attributes specified in attributes and their associated permissions.

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - if the org parameter is an Organization object that has already been deleted.

SmApiException

getOrgChain

java.util.Vector getOrgChain(Organization org,
                             java.util.Enumeration attributes)
                             throws SmApiException

Retrieves a branch of the organization hierarchy that begins at the root organization and extends downward to and including the specified parameter.

Parameters:

org - The lowest organization in the branch.

attributes - An Enumeration of Strings that specifies the attributes to include in retrieved objects. If you pass an empty Enumeration, no attributes are included. If you pass null, all attributes are included.

Returns:

The root organization and all sub-organizations down to and including the organization specified in org. The last element in the Vector is the organization passed in org, the second-last is the parent of org, and so on up to and including the root organization (the first element in the Vector).

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - if the org parameter is an Organization object that has already been deleted.

SmApiException

getOrgChain

java.util.Vector getOrgChain(TSContext context,
                             Organization org,
                             AttributeRightsCollection attributes)
                             throws SmApiException

Retrieves a branch of the organization hierarchy that begins at the root organization and extends downward to and including the specified parameter -- attribute permissions are included in the returned objects.

Parameters:

context - Context information for the current task session.

org - The lowest organization in the branch.

attributes - A collection of AttributeRight objects, each containing an attribute name and a permission request.

Returns:

The root organization and all sub-organizations down to and including the organization specified in org. The last element in the Vector is the organization passed in org, the second-last is the parent of org, and so on up to and including the root organization (the first element in the Vector).

Throws:

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - if the org parameter is an Organization object that has already been deleted.

SmApiException

findOrgsInScope

java.util.Vector findOrgsInScope(TSContext tsCtx,
                                 OrgFilter of,
                                 OrgScopeConstraint orgs,
                                 AttributeRightsCollection attrs)
                                 throws SmApiException

Retrieves the organizations within the current task that match the specified search criteria.

Parameters:

tsCtx - Context information about the current task, such as the user who is executing the task.

of - Attribute filter for the search. If no filter is specified, all organizations matching the other criteria will be returned.

orgs - Organization constraint for the search. If no constraint is specified, the search will occur within all organizations in the task context.

attrs - A collection of AttributeRight objects, each containing an attribute name and a permission request.

Returns:

A Vector of organization objects containing the attributes specified in attrs and the associated permissions.

Throws:

SmApiException

findOrgsInScope

java.util.Vector findOrgsInScope(TSContext tsCtx,
                                 OrgFilter of,
                                 OrgScopeConstraint orgs,
                                 AttributeRightsCollection attrs,
                                 ObjectType scopingType)
                                 throws SmApiException

Deprecated. Deprecated in Identity Manager 8.1. Use findOrgsInScope(), which omits scopingType.

Returns the set of orgs matching a search expresion set which are also in scope for the current task executed by the current admin.

Parameters:

tsCtx - Context information about the current task, such as the user who is executing the task.

of - Attribute filter for the search. If no filter is specified, all organizations matching the other criteria will be returned.

orgs - Organization constraint for the search. If no constraint is specified, the search will occur within all organizations in the task context.

attrs - A collection of AttributeRight objects, each containing an attribute name and a permission request.

scopingType -

Returns:

A Vector of organization objects containing the attributes specified in attrs and the associated permissions.

Throws:

SmApiException