Class: MicrosoftGraph::Models::FederatedIdentityCredential

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/federated_identity_credential.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Entity

#additional_data, #additional_data=, #id, #id=, #odata_type, #odata_type=

Constructor Details

#initialize ⇒ Object

Instantiates a new federatedIdentityCredential and sets the default values.



43
44
45
 
# File 'lib/models/federated_identity_credential.rb', line 43

def initialize()
    super
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node —

    The parse node to use to read the discriminator value and create the object

Returns:

  • a federated_identity_credential

Raises:

  • (StandardError) 


51
52
53
54
 
# File 'lib/models/federated_identity_credential.rb', line 51

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return FederatedIdentityCredential.new
end

Instance Method Details

#audiences ⇒ Object

Gets the audiences property value. The audience that can appear in the external token. This field is mandatory and should be set to api://AzureADTokenExchange for Azure AD. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. This field can only accept a single value and has a limit of 600 characters. Required.

Returns:

  • a string



28
29
30
 
# File 'lib/models/federated_identity_credential.rb', line 28

def audiences
    return @audiences
end

#audiences=(value) ⇒ Object

Sets the audiences property value. The audience that can appear in the external token. This field is mandatory and should be set to api://AzureADTokenExchange for Azure AD. It says what Microsoft identity platform should accept in the aud claim in the incoming token. This value represents Azure AD in your external identity provider and has no fixed value across identity providers - you may need to create a new application registration in your identity provider to serve as the audience of this token. This field can only accept a single value and has a limit of 600 characters. Required.

Parameters:

  • value —

    Value to set for the audiences property.

Returns:

  • a void



36
37
38
 
# File 'lib/models/federated_identity_credential.rb', line 36

def audiences=(value)
    @audiences = value
end

#description ⇒ Object

Gets the description property value. The un-validated, user-provided description of the federated identity credential. It has a limit of 600 characters. Optional.

Returns:

  • a string



59
60
61
 
# File 'lib/models/federated_identity_credential.rb', line 59

def description
    return @description
end

#description=(value) ⇒ Object

Sets the description property value. The un-validated, user-provided description of the federated identity credential. It has a limit of 600 characters. Optional.

Parameters:

  • value —

    Value to set for the description property.

Returns:

  • a void



67
68
69
 
# File 'lib/models/federated_identity_credential.rb', line 67

def description=(value)
    @description = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



74
75
76
77
78
79
80
81
82
 
# File 'lib/models/federated_identity_credential.rb', line 74

def get_field_deserializers()
    return super.merge({
        "audiences" => lambda {|n| @audiences = n.get_collection_of_primitive_values(String) },
        "description" => lambda {|n| @description = n.get_string_value() },
        "issuer" => lambda {|n| @issuer = n.get_string_value() },
        "name" => lambda {|n| @name = n.get_string_value() },
        "subject" => lambda {|n| @subject = n.get_string_value() },
    })
end

#issuer ⇒ Object

Gets the issuer property value. The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. It has a limit of 600 characters. Required.

Returns:

  • a string



87
88
89
 
# File 'lib/models/federated_identity_credential.rb', line 87

def issuer
    return @issuer
end

#issuer=(value) ⇒ Object

Sets the issuer property value. The URL of the external identity provider and must match the issuer claim of the external token being exchanged. The combination of the values of issuer and subject must be unique on the app. It has a limit of 600 characters. Required.

Parameters:

  • value —

    Value to set for the issuer property.

Returns:

  • a void



95
96
97
 
# File 'lib/models/federated_identity_credential.rb', line 95

def issuer=(value)
    @issuer = value
end

#name ⇒ Object

Gets the name property value. is the unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq).

Returns:

  • a string



102
103
104
 
# File 'lib/models/federated_identity_credential.rb', line 102

def name
    return @name
end

#name=(value) ⇒ Object

Sets the name property value. is the unique identifier for the federated identity credential, which has a limit of 120 characters and must be URL friendly. It is immutable once created. Required. Not nullable. Supports $filter (eq).

Parameters:

  • value —

    Value to set for the name property.

Returns:

  • a void



110
111
112
 
# File 'lib/models/federated_identity_credential.rb', line 110

def name=(value)
    @name = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer —

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError) 


118
119
120
121
122
123
124
125
126
 
# File 'lib/models/federated_identity_credential.rb', line 118

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_collection_of_primitive_values("audiences", @audiences)
    writer.write_string_value("description", @description)
    writer.write_string_value("issuer", @issuer)
    writer.write_string_value("name", @name)
    writer.write_string_value("subject", @subject)
end

#subject ⇒ Object

Gets the subject property value. Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. It has a limit of 600 characters. Supports $filter (eq).

Returns:

  • a string



131
132
133
 
# File 'lib/models/federated_identity_credential.rb', line 131

def subject
    return @subject
end

#subject=(value) ⇒ Object

Sets the subject property value. Required. The identifier of the external software workload within the external identity provider. Like the audience value, it has no fixed format, as each identity provider uses their own - sometimes a GUID, sometimes a colon delimited identifier, sometimes arbitrary strings. The value here must match the sub claim within the token presented to Azure AD. The combination of issuer and subject must be unique on the app. It has a limit of 600 characters. Supports $filter (eq).

Parameters:

  • value —

    Value to set for the subject property.

Returns:

  • a void



139
140
141
 
# File 'lib/models/federated_identity_credential.rb', line 139

def subject=(value)
    @subject = value
end