For Enterprise Grid workspaces, map local user IDs to global user IDs
GEThttps://slack.com/api/migration.exchangeapplication/x-www-form-urlencodedtokenAuthentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
xxxx-xxxxxxxxx-xxxxEasily convert your vintage user IDs to Enterprise Grid-friendly global user IDs.
This method is best used in conjunction with turning off the translation layer for your app, as a bulk conversion step just after a workspace migrates to Enterprise Grid.
By providing a list of "local" user IDs associated with the same workspace as your token, you can exchange your IDs for "global" user IDs beginning with the letter W or U.
You can use any existing tokens authorized for the team to request for the user mappings.
The to_old parameter is false by default. When false, the method returns a user_id_map mapping from local user IDs to global user IDs. For a reverse mapping from global user IDs back to local user IDs, set to_old to true.
The method may only be used on workspaces that have migrated to enterprise. When used on typical workspaces, a not_enterprise_team error is thrown.
Users that were already part of a workspace migrating to Enterprise Grid have two user IDs: a local user ID and a global user ID. Users that are created post-migration or on workspaces that are created after migration have only global user IDs.
When using this method and attempting to convert a global user ID to a local user ID and that corresponding user only has a global user ID, you'll receive the global user ID on both sides of the map.
Providing invalid users or user IDs not belonging to the related workspace will result with those IDs being listed in an invalid_user_ids array.
Typical success response when mappings exist for the specified user IDs
{
"ok": true,
"team_id": "T1KR7PE1W",
"enterprise_id": "E1KQTNXE1",
"user_id_map": {
"U06UBSUN5": "W06M56XJM",
"U06UEB62U": "W06PTT6GH",
"U06UBSVB3": "W06PUUDLY",
"U06UBSVDX": "W06PUUDMW",
"W06UAZ65Q": "W06UAZ65Q"
},
"invalid_user_ids": [
"U21ABZZXX"
]
}Typical error response when there are no mappings to provide
{
"ok": false,
"error": "not_enterprise_team"
} This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.
| Error | Description |
|---|---|
not_enterprise_team | The workspace associated with the token is not part of an Enterprise organization. User IDs have not changed and there is nothing to map. |
too_many_users | Too many user IDs provided in |
not_authed | No authentication token provided. |
invalid_auth | Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request. |
access_denied | Access to a resource specified in the request is denied. |
account_inactive | Authentication token is for a deleted user or workspace when using a |
token_revoked | Authentication token is for a deleted user or workspace or the app has been removed when using a |
token_expired | Authentication token has expired |
no_permission | The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to. |
org_login_required | The workspace is undergoing an enterprise migration and will not be available until migration is complete. |
ekm_access_denied | Administrators have suspended the ability to post a message. |
missing_scope | The token used is not granted the specific scope permissions required to complete this request. |
not_allowed_token_type | The token type used in this request is not allowed. |
method_deprecated | The method has been deprecated. |
deprecated_endpoint | The endpoint has been deprecated. |
two_factor_setup_required | Two factor setup is required. |
enterprise_is_restricted | The method cannot be called from an Enterprise. |
team_access_not_granted | The token used is not granted the specific workspace access required to complete this request. |
invalid_arguments | The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments. |
invalid_arg_name | The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than |
invalid_array_arg | The method was passed an array as an argument. Please only input valid strings. |
invalid_charset | The method was called via a |
invalid_form_data | The method was called via a |
invalid_post_type | The method was called via a |
missing_post_type | The method was called via a |
team_added_to_org | The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete. |
ratelimited | The request has been ratelimited. Refer to the |
accesslimited | Access to this method is limited on the current network |
request_timeout | The method was called via a |
service_unavailable | The service is temporarily unavailable |
fatal_error | The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised. |
internal_error | The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised. |
This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.
| Warning | Description |
|---|---|
missing_charset | The method was called via a |
superfluous_charset | The method was called via a |