Class: OpenAI::Models::Admin::Organization::Users::RoleListResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/admin/organization/users/role_list_response.rb

Overview

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, created_at:, created_by:, created_by_user_obj:, description:, metadata:, name:, permissions:, predefined_role:, resource_type:, updated_at:) ⇒ Object

Detailed information about a role assignment entry returned when listing assignments.

Parameters:

  • id (String) —

    Identifier for the role.

  • created_at (Integer, nil) —

    When the role was created.

  • created_by (String, nil) —

    Identifier of the actor who created the role.

  • created_by_user_obj (Hash{Symbol=>Object}, nil) —

    User details for the actor that created the role, when available.

  • description (String, nil) —

    Description of the role.

  • metadata (Hash{Symbol=>Object}, nil) —

    Arbitrary metadata stored on the role.

  • name (String) —

    Name of the role.

  • permissions (Array<String>) —

    Permissions associated with the role.

  • predefined_role (Boolean) —

    Whether the role is predefined by OpenAI.

  • resource_type (String) —

    Resource type the role applies to.

  • updated_at (Integer, nil) —

    When the role was last updated.




# File 'lib/openai/models/admin/organization/users/role_list_response.rb', line 78

Instance Attribute Details

#created_at ⇒ Integer?

When the role was created.

Returns:

  • (Integer, nil) 


20
 
# File 'lib/openai/models/admin/organization/users/role_list_response.rb', line 20

required :created_at, Integer, nil?: true

#created_by ⇒ String?

Identifier of the actor who created the role.

Returns:

  • (String, nil) 


26
 
# File 'lib/openai/models/admin/organization/users/role_list_response.rb', line 26

required :created_by, String, nil?: true

#created_by_user_obj ⇒ Hash{Symbol=>Object}?

User details for the actor that created the role, when available.

Returns:

  • (Hash{Symbol=>Object}, nil) 


32
33
34
 
# File 'lib/openai/models/admin/organization/users/role_list_response.rb', line 32

required :created_by_user_obj,
OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown],
nil?: true

#description ⇒ String?

Description of the role.

Returns:

  • (String, nil) 


40
 
# File 'lib/openai/models/admin/organization/users/role_list_response.rb', line 40

required :description, String, nil?: true

#id ⇒ String

Identifier for the role.

Returns:

  • (String) 


14
 
# File 'lib/openai/models/admin/organization/users/role_list_response.rb', line 14

required :id, String

#metadata ⇒ Hash{Symbol=>Object}?

Arbitrary metadata stored on the role.

Returns:

  • (Hash{Symbol=>Object}, nil) 


46
 
# File 'lib/openai/models/admin/organization/users/role_list_response.rb', line 46

required :metadata, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown], nil?: true

#name ⇒ String

Name of the role.

Returns:

  • (String) 


52
 
# File 'lib/openai/models/admin/organization/users/role_list_response.rb', line 52

required :name, String

#permissions ⇒ Array<String>

Permissions associated with the role.

Returns:

  • (Array<String>) 


58
 
# File 'lib/openai/models/admin/organization/users/role_list_response.rb', line 58

required :permissions, OpenAI::Internal::Type::ArrayOf[String]

#predefined_role ⇒ Boolean

Whether the role is predefined by OpenAI.

Returns:



64
 
# File 'lib/openai/models/admin/organization/users/role_list_response.rb', line 64

required :predefined_role, OpenAI::Internal::Type::Boolean

#resource_type ⇒ String

Resource type the role applies to.

Returns:

  • (String) 


70
 
# File 'lib/openai/models/admin/organization/users/role_list_response.rb', line 70

required :resource_type, String

#updated_at ⇒ Integer?

When the role was last updated.

Returns:

  • (Integer, nil) 


76
 
# File 'lib/openai/models/admin/organization/users/role_list_response.rb', line 76

required :updated_at, Integer, nil?: true