sfapi-ts

Home > @cjh1/sfapi > AccountService

AccountService class

Signature:

export declare class AccountService 

Constructors

Constructor	Modifiers	Description
(constructor)(httpRequest)		Constructs a new instance of the AccountService class

Properties

Property	Modifiers	Type	Description
httpRequest	readonly	BaseHttpRequest

Methods

Method	Modifiers	Description
createGroup(formData)		<p>Create Group Create a filegroup.</p><p>- **name**: the group’s name (max 8 characters, no unicode) - **repo_name**: the name of the project the group should belong to</p>
getGroup(group)		<p>Read Group Get information about a filegroup.</p><p>- **group**: the name of the group</p>
getGroups()		Read Groups Get the authenticated user’s file groups.
getProjects()		Read Projects Get the authenticated user’s NERSC projects.
getRoles()		Read Roles Get the authenticated user’s NERSC (Iris) roles.
getUser(username)		Read User Get the a user’s account information. (If none give, defaults to the authenticated user.)
updateGroup(group, formData)		<p>Update Group Membership Update a group’s membership.</p><p>- **group**: the name of the group - **usernames**: a comma-delimited list of usernames - **action**: the action to take: either batch_add or batch_remove</p>