Class: Twilio::REST::PreviewIam::Versionless::OrganizationContext::UserList::ScimUser

Inherits:
Object
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(payload) ⇒ ScimUser

Returns a new instance of ScimUser.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 42

def initialize(payload)
        @id = payload["id"]
        @external_id = payload["external_id"]
        @user_name = payload["user_name"]
        @display_name = payload["display_name"]
        @name = payload["name"]
        @emails = payload["emails"]
        @active = payload["active"]
        @locale = payload["locale"]
        @timezone = payload["timezone"]
        @schemas = payload["schemas"]
        @meta = payload["meta"]
        @detail = payload["detail"]
        @scim_type = payload["scim_type"]
        @status = payload["status"]
        @code = payload["code"]
        @more_info = payload["more_info"]
end

Instance Attribute Details

#activeObject

Parameters:

  • : (id)
    String

    Unique Twilio user sid

  • : (external_id)
    String

    External unique resource id defined by provisioning client

  • : (user_name)
    String

    Unique username, MUST be same as primary email address

  • : (display_name)
    String

    User friendly display name

  • : (name)
    UserList.ScimName
  • : (emails)
    Array<UserList.ScimEmailAddress>

    Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.

  • : (active)
    Boolean

    Indicates whether the user is active

  • : (locale)
    String

    User’s locale

  • : (timezone)
    String

    User’s time zone

  • : (schemas)
    Array<String>

    An array of URIs that indicate the schemas supported for this user resource

  • : (meta)
    UserList.ScimMeta
  • : (detail)
    String

    A human-readable description of the error

  • : (scim_type)
    String

    A scimType error code as defined in RFC7644

  • : (status)
    String

    Http status code

  • : (code)
    String

    Twilio-specific error code

  • : (more_info)
    String

    Link to Error Code References



41
42
43
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 41

def active
  @active
end

#codeObject

Parameters:

  • : (id)
    String

    Unique Twilio user sid

  • : (external_id)
    String

    External unique resource id defined by provisioning client

  • : (user_name)
    String

    Unique username, MUST be same as primary email address

  • : (display_name)
    String

    User friendly display name

  • : (name)
    UserList.ScimName
  • : (emails)
    Array<UserList.ScimEmailAddress>

    Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.

  • : (active)
    Boolean

    Indicates whether the user is active

  • : (locale)
    String

    User’s locale

  • : (timezone)
    String

    User’s time zone

  • : (schemas)
    Array<String>

    An array of URIs that indicate the schemas supported for this user resource

  • : (meta)
    UserList.ScimMeta
  • : (detail)
    String

    A human-readable description of the error

  • : (scim_type)
    String

    A scimType error code as defined in RFC7644

  • : (status)
    String

    Http status code

  • : (code)
    String

    Twilio-specific error code

  • : (more_info)
    String

    Link to Error Code References



41
42
43
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 41

def code
  @code
end

#detailObject

Parameters:

  • : (id)
    String

    Unique Twilio user sid

  • : (external_id)
    String

    External unique resource id defined by provisioning client

  • : (user_name)
    String

    Unique username, MUST be same as primary email address

  • : (display_name)
    String

    User friendly display name

  • : (name)
    UserList.ScimName
  • : (emails)
    Array<UserList.ScimEmailAddress>

    Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.

  • : (active)
    Boolean

    Indicates whether the user is active

  • : (locale)
    String

    User’s locale

  • : (timezone)
    String

    User’s time zone

  • : (schemas)
    Array<String>

    An array of URIs that indicate the schemas supported for this user resource

  • : (meta)
    UserList.ScimMeta
  • : (detail)
    String

    A human-readable description of the error

  • : (scim_type)
    String

    A scimType error code as defined in RFC7644

  • : (status)
    String

    Http status code

  • : (code)
    String

    Twilio-specific error code

  • : (more_info)
    String

    Link to Error Code References



41
42
43
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 41

def detail
  @detail
end

#display_nameObject

Parameters:

  • : (id)
    String

    Unique Twilio user sid

  • : (external_id)
    String

    External unique resource id defined by provisioning client

  • : (user_name)
    String

    Unique username, MUST be same as primary email address

  • : (display_name)
    String

    User friendly display name

  • : (name)
    UserList.ScimName
  • : (emails)
    Array<UserList.ScimEmailAddress>

    Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.

  • : (active)
    Boolean

    Indicates whether the user is active

  • : (locale)
    String

    User’s locale

  • : (timezone)
    String

    User’s time zone

  • : (schemas)
    Array<String>

    An array of URIs that indicate the schemas supported for this user resource

  • : (meta)
    UserList.ScimMeta
  • : (detail)
    String

    A human-readable description of the error

  • : (scim_type)
    String

    A scimType error code as defined in RFC7644

  • : (status)
    String

    Http status code

  • : (code)
    String

    Twilio-specific error code

  • : (more_info)
    String

    Link to Error Code References



41
42
43
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 41

def display_name
  @display_name
end

#emailsObject

Parameters:

  • : (id)
    String

    Unique Twilio user sid

  • : (external_id)
    String

    External unique resource id defined by provisioning client

  • : (user_name)
    String

    Unique username, MUST be same as primary email address

  • : (display_name)
    String

    User friendly display name

  • : (name)
    UserList.ScimName
  • : (emails)
    Array<UserList.ScimEmailAddress>

    Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.

  • : (active)
    Boolean

    Indicates whether the user is active

  • : (locale)
    String

    User’s locale

  • : (timezone)
    String

    User’s time zone

  • : (schemas)
    Array<String>

    An array of URIs that indicate the schemas supported for this user resource

  • : (meta)
    UserList.ScimMeta
  • : (detail)
    String

    A human-readable description of the error

  • : (scim_type)
    String

    A scimType error code as defined in RFC7644

  • : (status)
    String

    Http status code

  • : (code)
    String

    Twilio-specific error code

  • : (more_info)
    String

    Link to Error Code References



41
42
43
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 41

def emails
  @emails
end

#external_idObject

Parameters:

  • : (id)
    String

    Unique Twilio user sid

  • : (external_id)
    String

    External unique resource id defined by provisioning client

  • : (user_name)
    String

    Unique username, MUST be same as primary email address

  • : (display_name)
    String

    User friendly display name

  • : (name)
    UserList.ScimName
  • : (emails)
    Array<UserList.ScimEmailAddress>

    Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.

  • : (active)
    Boolean

    Indicates whether the user is active

  • : (locale)
    String

    User’s locale

  • : (timezone)
    String

    User’s time zone

  • : (schemas)
    Array<String>

    An array of URIs that indicate the schemas supported for this user resource

  • : (meta)
    UserList.ScimMeta
  • : (detail)
    String

    A human-readable description of the error

  • : (scim_type)
    String

    A scimType error code as defined in RFC7644

  • : (status)
    String

    Http status code

  • : (code)
    String

    Twilio-specific error code

  • : (more_info)
    String

    Link to Error Code References



41
42
43
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 41

def external_id
  @external_id
end

#idObject

Parameters:

  • : (id)
    String

    Unique Twilio user sid

  • : (external_id)
    String

    External unique resource id defined by provisioning client

  • : (user_name)
    String

    Unique username, MUST be same as primary email address

  • : (display_name)
    String

    User friendly display name

  • : (name)
    UserList.ScimName
  • : (emails)
    Array<UserList.ScimEmailAddress>

    Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.

  • : (active)
    Boolean

    Indicates whether the user is active

  • : (locale)
    String

    User’s locale

  • : (timezone)
    String

    User’s time zone

  • : (schemas)
    Array<String>

    An array of URIs that indicate the schemas supported for this user resource

  • : (meta)
    UserList.ScimMeta
  • : (detail)
    String

    A human-readable description of the error

  • : (scim_type)
    String

    A scimType error code as defined in RFC7644

  • : (status)
    String

    Http status code

  • : (code)
    String

    Twilio-specific error code

  • : (more_info)
    String

    Link to Error Code References



41
42
43
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 41

def id
  @id
end

#localeObject

Parameters:

  • : (id)
    String

    Unique Twilio user sid

  • : (external_id)
    String

    External unique resource id defined by provisioning client

  • : (user_name)
    String

    Unique username, MUST be same as primary email address

  • : (display_name)
    String

    User friendly display name

  • : (name)
    UserList.ScimName
  • : (emails)
    Array<UserList.ScimEmailAddress>

    Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.

  • : (active)
    Boolean

    Indicates whether the user is active

  • : (locale)
    String

    User’s locale

  • : (timezone)
    String

    User’s time zone

  • : (schemas)
    Array<String>

    An array of URIs that indicate the schemas supported for this user resource

  • : (meta)
    UserList.ScimMeta
  • : (detail)
    String

    A human-readable description of the error

  • : (scim_type)
    String

    A scimType error code as defined in RFC7644

  • : (status)
    String

    Http status code

  • : (code)
    String

    Twilio-specific error code

  • : (more_info)
    String

    Link to Error Code References



41
42
43
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 41

def locale
  @locale
end

#metaObject

Parameters:

  • : (id)
    String

    Unique Twilio user sid

  • : (external_id)
    String

    External unique resource id defined by provisioning client

  • : (user_name)
    String

    Unique username, MUST be same as primary email address

  • : (display_name)
    String

    User friendly display name

  • : (name)
    UserList.ScimName
  • : (emails)
    Array<UserList.ScimEmailAddress>

    Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.

  • : (active)
    Boolean

    Indicates whether the user is active

  • : (locale)
    String

    User’s locale

  • : (timezone)
    String

    User’s time zone

  • : (schemas)
    Array<String>

    An array of URIs that indicate the schemas supported for this user resource

  • : (meta)
    UserList.ScimMeta
  • : (detail)
    String

    A human-readable description of the error

  • : (scim_type)
    String

    A scimType error code as defined in RFC7644

  • : (status)
    String

    Http status code

  • : (code)
    String

    Twilio-specific error code

  • : (more_info)
    String

    Link to Error Code References



41
42
43
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 41

def meta
  @meta
end

#more_infoObject

Parameters:

  • : (id)
    String

    Unique Twilio user sid

  • : (external_id)
    String

    External unique resource id defined by provisioning client

  • : (user_name)
    String

    Unique username, MUST be same as primary email address

  • : (display_name)
    String

    User friendly display name

  • : (name)
    UserList.ScimName
  • : (emails)
    Array<UserList.ScimEmailAddress>

    Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.

  • : (active)
    Boolean

    Indicates whether the user is active

  • : (locale)
    String

    User’s locale

  • : (timezone)
    String

    User’s time zone

  • : (schemas)
    Array<String>

    An array of URIs that indicate the schemas supported for this user resource

  • : (meta)
    UserList.ScimMeta
  • : (detail)
    String

    A human-readable description of the error

  • : (scim_type)
    String

    A scimType error code as defined in RFC7644

  • : (status)
    String

    Http status code

  • : (code)
    String

    Twilio-specific error code

  • : (more_info)
    String

    Link to Error Code References



41
42
43
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 41

def more_info
  @more_info
end

#nameObject

Parameters:

  • : (id)
    String

    Unique Twilio user sid

  • : (external_id)
    String

    External unique resource id defined by provisioning client

  • : (user_name)
    String

    Unique username, MUST be same as primary email address

  • : (display_name)
    String

    User friendly display name

  • : (name)
    UserList.ScimName
  • : (emails)
    Array<UserList.ScimEmailAddress>

    Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.

  • : (active)
    Boolean

    Indicates whether the user is active

  • : (locale)
    String

    User’s locale

  • : (timezone)
    String

    User’s time zone

  • : (schemas)
    Array<String>

    An array of URIs that indicate the schemas supported for this user resource

  • : (meta)
    UserList.ScimMeta
  • : (detail)
    String

    A human-readable description of the error

  • : (scim_type)
    String

    A scimType error code as defined in RFC7644

  • : (status)
    String

    Http status code

  • : (code)
    String

    Twilio-specific error code

  • : (more_info)
    String

    Link to Error Code References



41
42
43
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 41

def name
  @name
end

#schemasObject

Parameters:

  • : (id)
    String

    Unique Twilio user sid

  • : (external_id)
    String

    External unique resource id defined by provisioning client

  • : (user_name)
    String

    Unique username, MUST be same as primary email address

  • : (display_name)
    String

    User friendly display name

  • : (name)
    UserList.ScimName
  • : (emails)
    Array<UserList.ScimEmailAddress>

    Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.

  • : (active)
    Boolean

    Indicates whether the user is active

  • : (locale)
    String

    User’s locale

  • : (timezone)
    String

    User’s time zone

  • : (schemas)
    Array<String>

    An array of URIs that indicate the schemas supported for this user resource

  • : (meta)
    UserList.ScimMeta
  • : (detail)
    String

    A human-readable description of the error

  • : (scim_type)
    String

    A scimType error code as defined in RFC7644

  • : (status)
    String

    Http status code

  • : (code)
    String

    Twilio-specific error code

  • : (more_info)
    String

    Link to Error Code References



41
42
43
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 41

def schemas
  @schemas
end

#scim_typeObject

Parameters:

  • : (id)
    String

    Unique Twilio user sid

  • : (external_id)
    String

    External unique resource id defined by provisioning client

  • : (user_name)
    String

    Unique username, MUST be same as primary email address

  • : (display_name)
    String

    User friendly display name

  • : (name)
    UserList.ScimName
  • : (emails)
    Array<UserList.ScimEmailAddress>

    Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.

  • : (active)
    Boolean

    Indicates whether the user is active

  • : (locale)
    String

    User’s locale

  • : (timezone)
    String

    User’s time zone

  • : (schemas)
    Array<String>

    An array of URIs that indicate the schemas supported for this user resource

  • : (meta)
    UserList.ScimMeta
  • : (detail)
    String

    A human-readable description of the error

  • : (scim_type)
    String

    A scimType error code as defined in RFC7644

  • : (status)
    String

    Http status code

  • : (code)
    String

    Twilio-specific error code

  • : (more_info)
    String

    Link to Error Code References



41
42
43
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 41

def scim_type
  @scim_type
end

#statusObject

Parameters:

  • : (id)
    String

    Unique Twilio user sid

  • : (external_id)
    String

    External unique resource id defined by provisioning client

  • : (user_name)
    String

    Unique username, MUST be same as primary email address

  • : (display_name)
    String

    User friendly display name

  • : (name)
    UserList.ScimName
  • : (emails)
    Array<UserList.ScimEmailAddress>

    Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.

  • : (active)
    Boolean

    Indicates whether the user is active

  • : (locale)
    String

    User’s locale

  • : (timezone)
    String

    User’s time zone

  • : (schemas)
    Array<String>

    An array of URIs that indicate the schemas supported for this user resource

  • : (meta)
    UserList.ScimMeta
  • : (detail)
    String

    A human-readable description of the error

  • : (scim_type)
    String

    A scimType error code as defined in RFC7644

  • : (status)
    String

    Http status code

  • : (code)
    String

    Twilio-specific error code

  • : (more_info)
    String

    Link to Error Code References



41
42
43
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 41

def status
  @status
end

#timezoneObject

Parameters:

  • : (id)
    String

    Unique Twilio user sid

  • : (external_id)
    String

    External unique resource id defined by provisioning client

  • : (user_name)
    String

    Unique username, MUST be same as primary email address

  • : (display_name)
    String

    User friendly display name

  • : (name)
    UserList.ScimName
  • : (emails)
    Array<UserList.ScimEmailAddress>

    Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.

  • : (active)
    Boolean

    Indicates whether the user is active

  • : (locale)
    String

    User’s locale

  • : (timezone)
    String

    User’s time zone

  • : (schemas)
    Array<String>

    An array of URIs that indicate the schemas supported for this user resource

  • : (meta)
    UserList.ScimMeta
  • : (detail)
    String

    A human-readable description of the error

  • : (scim_type)
    String

    A scimType error code as defined in RFC7644

  • : (status)
    String

    Http status code

  • : (code)
    String

    Twilio-specific error code

  • : (more_info)
    String

    Link to Error Code References



41
42
43
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 41

def timezone
  @timezone
end

#user_nameObject

Parameters:

  • : (id)
    String

    Unique Twilio user sid

  • : (external_id)
    String

    External unique resource id defined by provisioning client

  • : (user_name)
    String

    Unique username, MUST be same as primary email address

  • : (display_name)
    String

    User friendly display name

  • : (name)
    UserList.ScimName
  • : (emails)
    Array<UserList.ScimEmailAddress>

    Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.

  • : (active)
    Boolean

    Indicates whether the user is active

  • : (locale)
    String

    User’s locale

  • : (timezone)
    String

    User’s time zone

  • : (schemas)
    Array<String>

    An array of URIs that indicate the schemas supported for this user resource

  • : (meta)
    UserList.ScimMeta
  • : (detail)
    String

    A human-readable description of the error

  • : (scim_type)
    String

    A scimType error code as defined in RFC7644

  • : (status)
    String

    Http status code

  • : (code)
    String

    Twilio-specific error code

  • : (more_info)
    String

    Link to Error Code References



41
42
43
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 41

def user_name
  @user_name
end

Instance Method Details

#to_json(options = {}) ⇒ Object



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 60

def to_json(options = {})
{
        "id": @id,
        "externalId": @external_id,
        "userName": @user_name,
        "displayName": @display_name,
        "name": @name,
        "emails": @emails,
        "active": @active,
        "locale": @locale,
        "timezone": @timezone,
        "schemas": @schemas,
        "meta": @meta,
        "detail": @detail,
        "scimType": @scim_type,
        "status": @status,
        "code": @code,
        "moreInfo": @more_info,
}.to_json(options)
end