Struct Users 

pub struct Users<'c, C: Config> { /* private fields */ }

Available on crate feature administration only.

Manage users and their role in an organization. Users will be automatically added to the Default project.

Implementations

impl<'c, C: Config> Users<'c, C>

pub fn new(client: &'c Client<C>) -> Self

pub fn roles(&self, user_id: &str) -> UserRoles<'_, C>

To call UserRoles group related APIs using this client.

pub async fn list(&self) -> Result<UserListResponse, OpenAIError>

Lists all of the users in the organization. Lists all of the users in the organization.

pub async fn list_byot<R: DeserializeOwned>(&self) -> Result<R, OpenAIError>

Lists all of the users in the organization.

pub async fn modify( &self, user_id: &str, request: UserRoleUpdateRequest, ) -> Result<User, OpenAIError>

Modifies a user’s role in the organization. Modifies a user’s role in the organization.

pub async fn modify_byot<T0: Display, T1: Serialize, R: DeserializeOwned>( &self, user_id: T0, request: T1, ) -> Result<R, OpenAIError>

Modifies a user’s role in the organization.

pub async fn retrieve(&self, user_id: &str) -> Result<User, OpenAIError>

Retrieve a user by their identifier Retrieve a user by their identifier

pub async fn retrieve_byot<T0: Display, R: DeserializeOwned>( &self, user_id: T0, ) -> Result<R, OpenAIError>

Retrieve a user by their identifier

pub async fn delete( &self, user_id: &str, ) -> Result<UserDeleteResponse, OpenAIError>

Deletes a user from the organization. Deletes a user from the organization.

pub async fn delete_byot<T0: Display, R: DeserializeOwned>( &self, user_id: T0, ) -> Result<R, OpenAIError>

Deletes a user from the organization.

Trait Implementations

impl<'c, C: Config> RequestOptionsBuilder for Users<'c, C>

Available on crate feature _api only.

fn options_mut(&mut self) -> &mut RequestOptions

Get mutable reference to RequestOptions (for building)

fn options(&self) -> &RequestOptions

Get reference to RequestOptions

fn headers(self, headers: HeaderMap) -> Self

Add headers to RequestOptions

fn header<K, V>(self, key: K, value: V) -> Result<Self, OpenAIError>

where K: IntoHeaderName, V: TryInto<HeaderValue>, V::Error: Into<InvalidHeaderValue>,

Add a single header to RequestOptions

fn query<Q: Serialize + ?Sized>(self, query: &Q) -> Result<Self, OpenAIError>

Add query parameters to RequestOptions

fn path<P: Into<String>>(self, path: P) -> Result<Self, OpenAIError>

Add a path to RequestOptions