Class AccessTokenResponse

Namespace

NetCoreForce.Client.Models

Assembly

NetCoreForce.Client.dll

Access token response from a successful authentication

public class AccessTokenResponse

Inheritance

object

AccessTokenResponse

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AccessToken

Access token that acts as a session ID that the application uses for making requests. This token should be protected as though it were user credentials.

[JsonProperty(PropertyName = "access_token")]
public string AccessToken { get; set; }

Property Value

string

Id

Identity URL that can be used to both identify the user as well as query for more information about the user. Can be used in an HTTP request to get more information about the end user.

[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

string

IdToken

OpenID Token

A signed JSON Web Token (JWT) that contains authenticated user attributes. This is only returned if the scope parameter includes openid.

[JsonProperty(PropertyName = "id_token")]
public string IdToken { get; set; }

Property Value

string

InstanceUrl

Identifies the Salesforce instance to which API calls should be sent.

[JsonProperty(PropertyName = "instance_url")]
public string InstanceUrl { get; set; }

Property Value

string

IssuedAt

When the signature was created, represented as the number of seconds since the Unix epoch (00:00:00 UTC on 1 January 1970).

[JsonProperty(PropertyName = "issued_at")]
public long? IssuedAt { get; set; }

Property Value

long?

IssuedAtDateTime

Issued At value converted to DateTime

[JsonIgnore]
public DateTimeOffset? IssuedAtDateTime { get; }

Property Value

DateTimeOffset?

RefreshToken

Token that can be used in the future to obtain new access tokens. This value is a secret. You should treat it like the user's password and use appropriate measures to protect it. Not included with username-password auth flow.

[JsonProperty(PropertyName = "refresh_token")]
public string RefreshToken { get; set; }

Property Value

string

Scope

OAuth scope

may have several values in responses, e.g. "id full api openid refresh_token chatter_api"

https://developer.salesforce.com/docs/atlas.en-us.mobile_sdk.meta/mobile_sdk/oauth_scope_parameter_values.htm

[JsonProperty(PropertyName = "scope")]
public string Scope { get; set; }

Property Value

string

Signature

Base64-encoded HMAC-SHA256 signature signed with the consumer's private key containing the concatenated ID and signature issued_at value. The signature can be used to verify that the identity URL wasn’t modified because it was sent by the server.

[JsonProperty(PropertyName = "signature")]
public string Signature { get; set; }

Property Value

string

TokenType

OAuth 2.0 token type. Currently this is always "Bearer"

[JsonProperty(PropertyName = "token_type")]
public string TokenType { get; set; }

Property Value

string