class PureCloud::OAuthClientListing

Attributes

access_token_validity_seconds[RW]

The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied.

created_by[RW]

User that created this client

date_created[RW]

Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

date_modified[RW]

Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

date_to_delete[RW]

The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

description[RW]
id[RW]

The globally unique identifier for the object.

modified_by[RW]

User that last modified this client

name[RW]

The name of the OAuth client.

registered_redirect_uri[RW]

List of allowed callbacks for this client. For example: myap.example.com/auth/callback

role_divisions[RW]

Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant

role_ids[RW]

Deprecated. Use roleDivisions instead.

scope[RW]

The scope requested by this client. Scopes only apply to clients not using the client_credential grant

secret[RW]

System created secret assigned to this client. Secrets are required for code authorization and client credential grants.

self_uri[RW]

The URI for this object

state[RW]

The state of the OAuth client. Active: The OAuth client can be used to create access tokens. This is the default state. Disabled: Access tokens created by the client are invalid and new ones cannot be created. Inactive: Access tokens cannot be created with this OAuth client and it will be deleted.

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/purecloudplatformclientv2/models/o_auth_client_listing.rb, line 69
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'access_token_validity_seconds' => :'accessTokenValiditySeconds',
    
    :'description' => :'description',
    
    :'registered_redirect_uri' => :'registeredRedirectUri',
    
    :'secret' => :'secret',
    
    :'role_ids' => :'roleIds',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'created_by' => :'createdBy',
    
    :'modified_by' => :'modifiedBy',
    
    :'scope' => :'scope',
    
    :'role_divisions' => :'roleDivisions',
    
    :'state' => :'state',
    
    :'date_to_delete' => :'dateToDelete',
    
    :'self_uri' => :'selfUri'
    
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/purecloudplatformclientv2/models/o_auth_client_listing.rb, line 148
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  
  if attributes.has_key?(:'id')
    
    
    self.id = attributes[:'id']
    
  
  end

  
  if attributes.has_key?(:'name')
    
    
    self.name = attributes[:'name']
    
  
  end

  
  if attributes.has_key?(:'accessTokenValiditySeconds')
    
    
    self.access_token_validity_seconds = attributes[:'accessTokenValiditySeconds']
    
  
  end

  
  if attributes.has_key?(:'description')
    
    
    self.description = attributes[:'description']
    
  
  end

  
  if attributes.has_key?(:'registeredRedirectUri')
    
    if (value = attributes[:'registeredRedirectUri']).is_a?(Array)
      self.registered_redirect_uri = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'secret')
    
    
    self.secret = attributes[:'secret']
    
  
  end

  
  if attributes.has_key?(:'roleIds')
    
    if (value = attributes[:'roleIds']).is_a?(Array)
      self.role_ids = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'dateCreated')
    
    
    self.date_created = attributes[:'dateCreated']
    
  
  end

  
  if attributes.has_key?(:'dateModified')
    
    
    self.date_modified = attributes[:'dateModified']
    
  
  end

  
  if attributes.has_key?(:'createdBy')
    
    
    self.created_by = attributes[:'createdBy']
    
  
  end

  
  if attributes.has_key?(:'modifiedBy')
    
    
    self.modified_by = attributes[:'modifiedBy']
    
  
  end

  
  if attributes.has_key?(:'scope')
    
    if (value = attributes[:'scope']).is_a?(Array)
      self.scope = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'roleDivisions')
    
    if (value = attributes[:'roleDivisions']).is_a?(Array)
      self.role_divisions = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'state')
    
    
    self.state = attributes[:'state']
    
  
  end

  
  if attributes.has_key?(:'dateToDelete')
    
    
    self.date_to_delete = attributes[:'dateToDelete']
    
  
  end

  
  if attributes.has_key?(:'selfUri')
    
    
    self.self_uri = attributes[:'selfUri']
    
  
  end

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/o_auth_client_listing.rb, line 108
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'access_token_validity_seconds' => :'Integer',
    
    :'description' => :'String',
    
    :'registered_redirect_uri' => :'Array<String>',
    
    :'secret' => :'String',
    
    :'role_ids' => :'Array<String>',
    
    :'date_created' => :'DateTime',
    
    :'date_modified' => :'DateTime',
    
    :'created_by' => :'DomainEntityRef',
    
    :'modified_by' => :'DomainEntityRef',
    
    :'scope' => :'Array<String>',
    
    :'role_divisions' => :'Array<RoleDivision>',
    
    :'state' => :'String',
    
    :'date_to_delete' => :'DateTime',
    
    :'self_uri' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/o_auth_client_listing.rb, line 490
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      access_token_validity_seconds == o.access_token_validity_seconds &&
      description == o.description &&
      registered_redirect_uri == o.registered_redirect_uri &&
      secret == o.secret &&
      role_ids == o.role_ids &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      created_by == o.created_by &&
      modified_by == o.modified_by &&
      scope == o.scope &&
      role_divisions == o.role_divisions &&
      state == o.state &&
      date_to_delete == o.date_to_delete &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/o_auth_client_listing.rb, line 543
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

# File lib/purecloudplatformclientv2/models/o_auth_client_listing.rb, line 603
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

build the object from hash

# File lib/purecloudplatformclientv2/models/o_auth_client_listing.rb, line 524
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/o_auth_client_listing.rb, line 513
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/purecloudplatformclientv2/models/o_auth_client_listing.rb, line 519
def hash
  [id, name, access_token_validity_seconds, description, registered_redirect_uri, secret, role_ids, date_created, date_modified, created_by, modified_by, scope, role_divisions, state, date_to_delete, self_uri].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/purecloudplatformclientv2/models/o_auth_client_listing.rb, line 311
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
state=(state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned

# File lib/purecloudplatformclientv2/models/o_auth_client_listing.rb, line 467
def state=(state)
  allowed_values = ["active", "disabled", "inactive"]
  if state && !allowed_values.include?(state)
    fail ArgumentError, "invalid value for 'state', must be one of #{allowed_values}."
  end
  @state = state
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/o_auth_client_listing.rb, line 586
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/o_auth_client_listing.rb, line 591
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source
# File lib/purecloudplatformclientv2/models/o_auth_client_listing.rb, line 581
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/purecloudplatformclientv2/models/o_auth_client_listing.rb, line 320
def valid?
  
  
  
  
  
  
  if @name.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["active", "disabled", "inactive"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
end