Class: OpenAI::Resources::Admin::Organization::Users

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/admin/organization/users.rb,
lib/openai/resources/admin/organization/users/roles.rb,
sig/openai/resources/admin/organization/users.rbs,
sig/openai/resources/admin/organization/users/roles.rbs

Defined Under Namespace

Classes: Roles

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Users

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Users.

Parameters:



130
131
132
133
 
# File 'lib/openai/resources/admin/organization/users.rb', line 130

def initialize(client:)
  @client = client
  @roles = OpenAI::Resources::Admin::Organization::Users::Roles.new(client: client)
end

Instance Attribute Details

#roles ⇒ OpenAI::Resources::Admin::Organization::Users::Roles (readonly)

Returns:



9
10
11
 
# File 'lib/openai/resources/admin/organization/users.rb', line 9

def roles
  @roles
end

Instance Method Details

#delete(user_id, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::UserDeleteResponse

Deletes a user from the organization.

Parameters:

  • user_id (String) —

    The ID of the user.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



117
118
119
120
121
122
123
124
125
 
# File 'lib/openai/resources/admin/organization/users.rb', line 117

def delete(user_id, params = {})
  @client.request(
    method: :delete,
    path: ["organization/users/%1$s", user_id],
    model: OpenAI::Models::Admin::Organization::UserDeleteResponse,
    security: {admin_api_key_auth: true},
    options: params[:request_options]
  )
end

#list(after: nil, emails: nil, limit: nil, request_options: {}) ⇒ OpenAI::Internal::ConversationCursorPage<OpenAI::Models::Admin::Organization::OrganizationUser>

Lists all of the users in the organization.

Parameters:

  • after (String) —

    A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

  • emails (Array<String>) —

    Filter by the email address of users.

  • limit (Integer) —

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/openai/resources/admin/organization/users.rb', line 91

def list(params = {})
  parsed, options = OpenAI::Admin::Organization::UserListParams.dump_request(params)
  query = OpenAI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "organization/users",
    query: query,
    page: OpenAI::Internal::ConversationCursorPage,
    model: OpenAI::Admin::Organization::OrganizationUser,
    security: {admin_api_key_auth: true},
    options: options
  )
end

#retrieve(user_id, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::OrganizationUser

Retrieves a user by their identifier.

Parameters:

  • user_id (String) —

    The ID of the user.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



23
24
25
26
27
28
29
30
31
 
# File 'lib/openai/resources/admin/organization/users.rb', line 23

def retrieve(user_id, params = {})
  @client.request(
    method: :get,
    path: ["organization/users/%1$s", user_id],
    model: OpenAI::Admin::Organization::OrganizationUser,
    security: {admin_api_key_auth: true},
    options: params[:request_options]
  )
end

#update(user_id, developer_persona: nil, role: nil, role_id: nil, technical_level: nil, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::OrganizationUser

Modifies a user's role in the organization.

Parameters:

  • user_id (String) —

    The ID of the user.

  • developer_persona (String, nil) —

    Developer persona metadata.

  • role (String, nil) —

    owner or reader

  • role_id (String, nil) —

    Role ID to assign to the user.

  • technical_level (String, nil) —

    Technical level metadata.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/openai/resources/admin/organization/users.rb', line 57

def update(user_id, params = {})
  parsed, options = OpenAI::Admin::Organization::UserUpdateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["organization/users/%1$s", user_id],
    body: parsed,
    model: OpenAI::Admin::Organization::OrganizationUser,
    security: {admin_api_key_auth: true},
    options: options
  )
end