RLMAPIKeyAuth

Objective-C


@interface RLMAPIKeyAuth : RLMProviderClient

Swift

@_nonSendable(_assumed) class RLMAPIKeyAuth : RLMProviderClient, @unchecked Sendable

Provider client for user API keys.

Show on GitHub


                    
                    
                    -createAPIKeyWithName:completion:

Creates a user API key that can be used to authenticate as the current user.

Objective-C

- (void)createAPIKeyWithName:(nonnull NSString *)name
                  completion:(nonnull RLMOptionalUserAPIKeyBlock)completion;

Swift

func createAPIKey(named name: String) async throws -> RLMUserAPIKey

`name`	The name of the API key to be created.
`completion`	A callback to be invoked once the call is complete.

Show on GitHub


                    
                    
                    -fetchAPIKey:completion:

Fetches a user API key associated with the current user.

Objective-C

- (void)fetchAPIKey:(nonnull RLMObjectId *)objectId
         completion:(nonnull RLMOptionalUserAPIKeyBlock)completion;

Swift

func fetchAPIKey(_ objectId: RLMObjectId) async throws -> RLMUserAPIKey

`objectId`	The ObjectId of the API key to fetch.
`completion`	A callback to be invoked once the call is complete.

Show on GitHub


                    
                    
                    -fetchAPIKeysWithCompletion:

Fetches the user API keys associated with the current user.

Objective-C

- (void)fetchAPIKeysWithCompletion:(nonnull RLMUserAPIKeysBlock)completion;

Swift

func fetchAPIKeys() async throws -> [RLMUserAPIKey]


                                completion

A callback to be invoked once the call is complete.

Show on GitHub


                    
                    
                    -deleteAPIKey:completion:

Deletes a user API key associated with the current user.

Objective-C

- (void)deleteAPIKey:(nonnull RLMObjectId *)objectId
          completion:(nonnull RLMAPIKeyAuthOptionalErrorBlock)completion;

Swift

func deleteAPIKey(_ objectId: RLMObjectId) async throws

`objectId`	The ObjectId of the API key to delete.
`completion`	A callback to be invoked once the call is complete.

Show on GitHub


                    
                    
                    -enableAPIKey:completion:

Enables a user API key associated with the current user.

Objective-C

- (void)enableAPIKey:(nonnull RLMObjectId *)objectId
          completion:(nonnull RLMAPIKeyAuthOptionalErrorBlock)completion;

Swift

func enableAPIKey(_ objectId: RLMObjectId) async throws

`objectId`	The ObjectId of the API key to enable.
`completion`	A callback to be invoked once the call is complete.

Show on GitHub


                    
                    
                    -disableAPIKey:completion:

Disables a user API key associated with the current user.

Objective-C

- (void)disableAPIKey:(nonnull RLMObjectId *)objectId
           completion:(nonnull RLMAPIKeyAuthOptionalErrorBlock)completion;

Swift

func disableAPIKey(_ objectId: RLMObjectId) async throws

`objectId`	The ObjectId of the API key to disable.
`completion`	A callback to be invoked once the call is complete.

Show on GitHub