ProfilesApi: Agave Profiles API operations

Description Usage Format Details Methods See Also

Description

ProfilesApi Class

The Profiles API is a user directory service for the Agave Platform.

Usage

1
profiles <- ProfilesApi$new(apiClient, cache, responseType="list")

Format

An object of class R6ClassGenerator of length 24.

Details

The Profiles API is a user directory service for the Agave Platform. Users may query it for their own profile and search for the profile(s) of other users. Depending on the configuration of your tenant, additional features such as profile editing, profile creation, and password reset may be enabled as well.

Methods

$addProfile(body) Create a new user profile. This may be disabled depending on the configuration of your specific tenant.

Usage

1
2
3
4
profile <- Profile$new(username="username",
                       password="password",
                       email="[email protected]")
api$profiles$addProfile(body=profile)

$deleteProfile(username=username) deletes a user profile. The user's data and history is maintained. Depending on the backend identity provider, the user account may or may not be avaialble for reuse/reactivation.

Usage

1
api$profiles$deleteProfile(username="username")

$getProfile(username) get the full profile of a given user.

Usage

1
2
api$profiles$getProfile()
api$profiles$getProfile(username="username")

$listProfiles(username, name, email) list user profiles, filtering by partial match on username, full name, or email address.

Usage

1
2
3
4
api$profiles$listProfiles()
api$profiles$listProfiles(username="test")
api$profiles$listProfiles(name="Test")
api$profiles$listProfiles(email="[email protected]")

$updateProfile Update an existing user profile. This may be disabled depending on the configuration of your specific tenant.

Usage

1
2
3
4
profile <- Profile$new(username="username",
                       password="newpassword",
                       email="[email protected]")
api$profiles$updateProfile(username="username", body=profile)

See Also

rAgave::Profile rAgave::ClientsApi rAgave::Client rAgave::ApiClient rAgave::Agave


agaveplatform/r-sdk documentation built on Sept. 22, 2018, 2:14 p.m.