MSALAccountEnumerationParameters

Objective-C

@interface MSALAccountEnumerationParameters : MSALParameters

Swift

class MSALAccountEnumerationParameters : MSALParameters

MSALAccountEnumerationParameters represents possible account identifying parameters that could be used for filtering cached accounts.

Filtering options

  • Unique identifier for the account.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *identifier;

    Swift

    var identifier: String? { get }

  • Unique identifier for the tenant profile.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *tenantProfileIdentifier;

    Swift

    var tenantProfileIdentifier: String? { get }

  • Shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *username;

    Swift

    var username: String? { get }

  • Filter accounts by whether this account is in the signed in state for the current client. Signed in state is determined by the presence of a refresh token credential for the requesting client. If account has been explicitly removed through the “removeAccount” API, it will be also marked as “signed out” as MSAL will remove refresh token for the client.

    YES by default (== only returns signed in accounts). Set it to NO to query all accounts visible to your application regardless if there’s a refresh token present or not.

    Declaration

    Objective-C

    @property (nonatomic) BOOL returnOnlySignedInAccounts;

    Swift

    var returnOnlySignedInAccounts: Bool { get set }

Initializing enumeration parameters

  • Creates a filter with an account identifier.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithIdentifier:
    (nonnull NSString *)accountIdentifier;

    Swift

    init(identifier accountIdentifier: String)

    Parameters

    accountIdentifier

    Unique identifier for the account.

  • Creates a filter with an account identifier and a displayable username.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithIdentifier:
                            (nullable NSString *)accountIdentifier
                                  username:(nonnull NSString *)username;

    Swift

    init(identifier accountIdentifier: String?, username: String)

    Parameters

    accountIdentifier

    Unique identifier for the account.
    username

    Shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace.

  • Creates a filter with a tenant profile identifier.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTenantProfileIdentifier:
    (nonnull NSString *)tenantProfileIdentifier;

    Swift

    init(tenantProfileIdentifier: String)

    Parameters

    tenantProfileIdentifier

    Unique identifier for the tenant profile.