MSALUser Class Reference

Inherits from NSObject
Conforms to NSCopying
Declared in MSALUser.h

  displayableId

The displayable value in UserPrincipleName(UPN) format. Can be nil if not returned from the service.
@property (readonly) NSString *displayableId

Discussion

The displayable value in UserPrincipleName(UPN) format. Can be nil if not returned from the service.

Declared In

MSALUser.h

  name

The given name of the user. Can be nil if not returned by the service.
@property (readonly) NSString *name

Discussion

The given name of the user. Can be nil if not returned by the service.

Declared In

MSALUser.h

  identityProvider

The identity provider of the user authenticated. Can be nil if not returned by the service.
@property (readonly) NSString *identityProvider

Discussion

The identity provider of the user authenticated. Can be nil if not returned by the service.

Declared In

MSALUser.h

  uid

Unique identifier of the user. Can be nil if not returned by the service.
@property (readonly) NSString *uid

Discussion

Unique identifier of the user. Can be nil if not returned by the service.

Declared In

MSALUser.h

  utid

Unique tenant identifier of the user. Can be nil if not returned by the service.
@property (readonly) NSString *utid

Discussion

Unique tenant identifier of the user. Can be nil if not returned by the service.

Declared In

MSALUser.h

  environment

Host part of the authority string used for authentication.
@property (readonly) NSString *environment

Discussion

Host part of the authority string used for authentication.

Declared In

MSALUser.h

– initWithIdToken:clientInfo:environment:

Initialize a MSALUser by extracting information from id token and client info.
- (id)initWithIdToken:(MSALIdToken *)idToken clientInfo:(MSALClientInfo *)clientInfo environment:(NSString *)environment

Parameters

idToken

A MSALIdToken object that holds information extracted from the raw id token

clientInfo

Client info returned by the service

environment

Host part of the authority string

Discussion

Initialize a MSALUser by extracting information from id token and client info.

Declared In

MSALUser.h

– initWithDisplayableId:name:identityProvider:uid:utid:environment:

Initialize a MSALUser with given information
- (id)initWithDisplayableId:(NSString *)displayableId name:(NSString *)name identityProvider:(NSString *)identityProvider uid:(NSString *)uid utid:(NSString *)utid environment:(NSString *)environment

Parameters

displayableId

The displayable value in UserPrincipleName(UPN) format

name

The given name of the user

identityProvider

The identity provider of the user authenticated

uid

Unique identifier of the user

utid

Unique tenant identifier of the user

environment

Host part of the authority string

Discussion

Initialize a MSALUser with given information

Declared In

MSALUser.h

– userIdentifier

Returns the unique identifier of the user, which is a combination of uid and utid properties
- (NSString *)userIdentifier

Discussion

Returns the unique identifier of the user, which is a combination of uid and utid properties

Declared In

MSALUser.h