Class: OpenAI::Models::Admin::Organization::Users::RoleRetrieveResponse

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

Overview

See Also:

Defined Under Namespace

Classes: AssignmentSource

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from OpenAI::Internal::Type::BaseModel

Instance Attribute Details

#assignment_sources ⇒ Array<OpenAI::Models::Admin::Organization::Users::RoleRetrieveResponse::AssignmentSource>?

Principals from which the role assignment is inherited, when available.

Returns:



20
21
22
 
# File 'lib/openai/models/admin/organization/users/role_retrieve_response.rb', line 20

required :assignment_sources,
-> { OpenAI::Internal::Type::ArrayOf[OpenAI::Models::Admin::Organization::Users::RoleRetrieveResponse::AssignmentSource] },
nil?: true

#created_at ⇒ Integer?

When the role was created.

Returns:

  • (Integer, nil) 


28
 
# File 'lib/openai/models/admin/organization/users/role_retrieve_response.rb', line 28

required :created_at, Integer, nil?: true

#created_by ⇒ String?

Identifier of the actor who created the role.

Returns:

  • (String, nil) 


34
 
# File 'lib/openai/models/admin/organization/users/role_retrieve_response.rb', line 34

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) 


40
41
42
 
# File 'lib/openai/models/admin/organization/users/role_retrieve_response.rb', line 40

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

#description ⇒ String?

Description of the role.

Returns:

  • (String, nil) 


48
 
# File 'lib/openai/models/admin/organization/users/role_retrieve_response.rb', line 48

required :description, String, nil?: true

#id ⇒ String

Identifier for the role.

Returns:

  • (String) 


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

required :id, String

#metadata ⇒ Hash{Symbol=>Object}?

Arbitrary metadata stored on the role.

Returns:

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


54
 
# File 'lib/openai/models/admin/organization/users/role_retrieve_response.rb', line 54

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

#name ⇒ String

Name of the role.

Returns:

  • (String) 


60
 
# File 'lib/openai/models/admin/organization/users/role_retrieve_response.rb', line 60

required :name, String

#permissions ⇒ Array<String>

Permissions associated with the role.

Returns:

  • (Array<String>) 


66
 
# File 'lib/openai/models/admin/organization/users/role_retrieve_response.rb', line 66

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

#predefined_role ⇒ Boolean

Whether the role is predefined by OpenAI.

Returns:



72
 
# File 'lib/openai/models/admin/organization/users/role_retrieve_response.rb', line 72

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

#resource_type ⇒ String

Resource type the role applies to.

Returns:

  • (String) 


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

required :resource_type, String

#updated_at ⇒ Integer?

When the role was last updated.

Returns:

  • (Integer, nil) 


84
 
# File 'lib/openai/models/admin/organization/users/role_retrieve_response.rb', line 84

required :updated_at, Integer, nil?: true