|
Primary groups
|
admin | Get user's primary groups |
auto_assign_users | Auto assign users for this descriptor. (administrative) |
create_descriptor | Create a descriptor of primary groups. (administrative) |
delete_descriptors | Delete descriptors of primary groups. (administrative) |
descriptor | Get information on a given descriptor of primary groups. (administrative) |
descriptors | Get information on multiple descriptors of primary groups. (administrative) |
descriptors_all | Get a list of all descriptors of primary groups. (administrative) |
primary_group | Get information on a given primary group. |
primary_groups | Get information on multiple primary groups. |
schema | Get a schema of descriptors of primary groups. (administrative) |
update_descriptor | Update a descriptor of primary groups. (administrative) |
update_user | Change primary groups assigned to the user. (administrative) |
user | Get user's primary groups |
services/prgroups/admin ¶
|
||||||
URLs of the methods are hidden, because this installation is
the mother server.
Click here for the list of all public USOS API installations. |
||||||
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Get a list of user's primary groups. Only those groups with full access will be included which supergroup access is partial. | ||||||
user_id | optional |
Default value: (unused) ID of a user whose group contents should be returned. This argument may be used only by users with proper administrative privileges. |
||||
fields | optional |
Default value: id|name Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of primary_group method. |
||||
format | optional |
Default value: json Format in which to return values. See supported output formats. |
||||
callback | optional |
Required only if you've chosen jsonp as a return format. |
||||
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization. | ||||||
Returned value: A list of dictionaries describing primary groups. Each dictionary contains keys listed in fields argument. | ||||||
Thrown errors:
|
services/prgroups/auto_assign_users ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
URLs of the methods are hidden, because this installation is
the mother server.
Click here for the list of all public USOS API installations. |
||||||
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Auto assign users for this descriptor. | ||||||
descriptor_id | required |
Descriptor ID. |
||||
format | optional |
Default value: json Format in which to return values. See supported output formats. |
||||
callback | optional |
Required only if you've chosen jsonp as a return format. |
||||
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Token is not required. | ||||||
Returned value: Empty dict on success | ||||||
Thrown errors:
|
services/prgroups/create_descriptor ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
URLs of the methods are hidden, because this installation is
the mother server.
Click here for the list of all public USOS API installations. |
||||||
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Create a descriptor of primary groups. | ||||||
source | required |
An XML representation of the descriptor. |
||||
dry_run | optional |
Default value: false Validate submitted arguments, but do not perform any persistent changes. |
||||
format | optional |
Default value: json Format in which to return values. See supported output formats. |
||||
callback | optional |
Required only if you've chosen jsonp as a return format. |
||||
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Token is not required. | ||||||
Returned value: A dictionary of the following structure:
| ||||||
Thrown errors:
|
services/prgroups/delete_descriptors ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
URLs of the methods are hidden, because this installation is
the mother server.
Click here for the list of all public USOS API installations. |
||||||
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Delete descriptors of primary groups. | ||||||
descriptor_ids | required |
List of descriptor IDs. |
||||
format | optional |
Default value: json Format in which to return values. See supported output formats. |
||||
callback | optional |
Required only if you've chosen jsonp as a return format. |
||||
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Token is not required. | ||||||
Returned value: A dictionary of the following structure:
|
services/prgroups/descriptor ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
URLs of the methods are hidden, because this installation is
the mother server.
Click here for the list of all public USOS API installations. |
||||||
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Get information on a given descriptor of primary groups. | ||||||
descriptor_id | required |
Descriptor ID. |
||||
fields | optional |
Default value: id|name Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
format | optional |
Default value: json Format in which to return values. See supported output formats. |
||||
callback | optional |
Required only if you've chosen jsonp as a return format. |
||||
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Token is not required. | ||||||
Returned value: A dictionary of selected fields and their values. Available fields:
| ||||||
Thrown errors:
|
services/prgroups/descriptors ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
URLs of the methods are hidden, because this installation is
the mother server.
Click here for the list of all public USOS API installations. |
||||||
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Get information on multiple descriptors of primary groups. | ||||||
descriptor_ids | required |
List of descriptor IDs. |
||||
fields | optional |
Default value: id|name Selector of result fields you are interested in. The selector must contain subset of primary fields, which are described in the returns section of descriptor method. |
||||
format | optional |
Default value: json Format in which to return values. See supported output formats. |
||||
callback | optional |
Required only if you've chosen jsonp as a return format. |
||||
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Token is not required. | ||||||
Returned value: A dictionary mapping descriptor IDs to dictionaries describing the descriptors (as returned by descriptor method). If specified descriptor could not be found, null is returned instead of a dictionary. |
services/prgroups/descriptors_all ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
URLs of the methods are hidden, because this installation is
the mother server.
Click here for the list of all public USOS API installations. |
||||||
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Get a list of all descriptors of primary groups. | ||||||
fields | optional |
Default value: id|name Selector of result fields you are interested in. The selector must contain subset of primary fields, which are described in the returns section of descriptor method. |
||||
format | optional |
Default value: json Format in which to return values. See supported output formats. |
||||
callback | optional |
Required only if you've chosen jsonp as a return format. |
||||
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Token is not required. | ||||||
Returned value: A list of dictionaries describing descriptors (as returned by descriptor method). |
services/prgroups/primary_group ¶
|
||||||
URLs of the methods are hidden, because this installation is
the mother server.
Click here for the list of all public USOS API installations. |
||||||
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Get information on a given primary group. | ||||||
primary_group_id | required |
Primary group ID. Note that an empty string is a valid ID value. |
||||
user_id | optional |
Default value: (unused) ID of a user whose group contents should be returned. This argument may be used only by users with proper administrative privileges. |
||||
fields | optional |
Default value: id|name Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
format | optional |
Default value: json Format in which to return values. See supported output formats. |
||||
callback | optional |
Required only if you've chosen jsonp as a return format. |
||||
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization. | ||||||
Returned value: A dictionary of selected fields and their values. Available fields:
| ||||||
Thrown errors:
|
services/prgroups/primary_groups ¶
|
||||||
URLs of the methods are hidden, because this installation is
the mother server.
Click here for the list of all public USOS API installations. |
||||||
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Get information on multiple primary groups. | ||||||
primary_group_ids | required |
List of primary group IDs. |
||||
user_id | optional |
Default value: (unused) ID of a user whose group contents should be returned. This argument may be used only by users with proper administrative privileges. |
||||
fields | optional |
Default value: id|name Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of primary_group method. |
||||
format | optional |
Default value: json Format in which to return values. See supported output formats. |
||||
callback | optional |
Required only if you've chosen jsonp as a return format. |
||||
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization. | ||||||
Returned value: A dictionary mapping primary group IDs to dictionaries describing the groups (as returned by primary_group method). If specified group could not be found, null is returned instead of a dictionary. | ||||||
Thrown errors:
|
services/prgroups/schema ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
URLs of the methods are hidden, because this installation is
the mother server.
Click here for the list of all public USOS API installations. |
||||||
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Get a schema of descriptors of primary groups. | ||||||
(this method takes no parameters) | ||||||
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Token is not required. | ||||||
Returned value: An XML Schema file. |
services/prgroups/update_descriptor ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
URLs of the methods are hidden, because this installation is
the mother server.
Click here for the list of all public USOS API installations. |
||||||
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Update a descriptor of primary groups. | ||||||
descriptor_id | required |
Descriptor ID. |
||||
source | required |
An XML representation of the descriptor. |
||||
dry_run | optional |
Default value: false Validate submitted arguments, but do not perform any persistent changes. |
||||
format | optional |
Default value: json Format in which to return values. See supported output formats. |
||||
callback | optional |
Required only if you've chosen jsonp as a return format. |
||||
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Token is not required. | ||||||
Returned value: An empty dictionary returned if the method has been executed successfully. Some keys may be added in the future. | ||||||
Thrown errors:
|
services/prgroups/update_user ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
URLs of the methods are hidden, because this installation is
the mother server.
Click here for the list of all public USOS API installations. |
||||||
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Change primary groups assigned to the user. Currently calling this method with access token causes a method_forbidden error. | ||||||
user_id | required |
User ID. |
||||
primary_group_ids | required |
List of primary group IDs. |
||||
format | optional |
Default value: json Format in which to return values. See supported output formats. |
||||
callback | optional |
Required only if you've chosen jsonp as a return format. |
||||
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization. | ||||||
Returned value: An empty dictionary returned if the method has been executed successfully. Some keys may be added in the future. | ||||||
Thrown errors:
|
services/prgroups/user ¶
|
||||||
URLs of the methods are hidden, because this installation is
the mother server.
Click here for the list of all public USOS API installations. |
||||||
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Get a list of user's primary groups. Only those groups with full access will be included which supergroup access is partial. | ||||||
user_id | optional |
Default value: (unused) ID of a user whose group contents should be returned. This argument may be used only by users with proper administrative privileges. |
||||
fields | optional |
Default value: id|name Selector of result fields you are interested in. The selector must contain subset of primary fields, which are described in the returns section of primary_group method. |
||||
access | optional |
Default value: full Filter groups with selected user access |
||||
format | optional |
Default value: json Format in which to return values. See supported output formats. |
||||
callback | optional |
Required only if you've chosen jsonp as a return format. |
||||
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization. | ||||||
Returned value: A list of dictionaries describing primary groups. Each dictionary contains keys listed in fields argument. | ||||||
Thrown errors:
|