Has Pending Mappings | iOS API Client V7 (Deprecated)

This method is not yet available in the Swift API client.

About this method

Get the status of your clusters’ migrations or user creations.

Creating a large batch of users or migrating your multi-cluster may take quite some time. This method lets you retrieve the status of the migration, so you can know when it’s done.

Examples

Has pending mappings

1
$client->hasPendingMappings(true);

1
# This method is not yet available in the Ruby API client.

1
client.hasPendingMappings(true);

1
client.has_pending_mappings(True)

1
client.HasPendingMappings(true)

1
client.hasPendingMappings(true)

1
2
3
client.HasPendingMappings(
  opt.RetrieveMappings(true),
)

1
2
3
client.execute {
  has pendingMappings(true)
}

1
client.hasPendingMapping(retrieveMapping = true)

Parameters

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

1
2
3
4
5
6
7
8
9
10
11
{
  "pending": true,
  "clusters": {
    "cluster_1": [
      'user1',
      'user2',
      'user...',
      'user99999'
    ]
  }
}