> ## Documentation Index
> Fetch the complete documentation index at: https://support.fortanix.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Synchronize information about the external role by retrieving it from external source.

> Synchronize information about the external role by retrieving it from external source.

## OpenAPI

````json POST /sys/v1/external_roles/{external_role_id}/sync
{
  "openapi": "3.0.0",
  "info": {
    "title": "Fortanix DSM REST API",
    "description": "This is a set of REST APIs for accessing the Fortanix Data Security Manager. This includes APIs for managing accounts, and for performing cryptographic and key management operations. \n\n **Note:** \n- All binary input should be base64-encoded. These fields are marked with `format: byte`. \n- For forward compatibility, any API client is expected to ignore any fields in the response not explicitly mentioned in the documentation. We reserve the right to add new fields at any time to provide new functionality without affecting existing API clients.",
    "termsOfService": "https://www.fortanix.com/legal/terms/",
    "contact": {
      "name": "Fortanix Support",
      "url": "https://support.fortanix.com/",
      "email": "support@fortanix.com"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "version": "0.1.0-20260526"
  },
  "servers": [
    {
      "url": "https://amer.smartkey.io"
    }
  ],
  "paths": {
    "/sys/v1/external_roles/{external_role_id}/sync": {
      "post": {
        "operationId": "SyncExternalRole",
        "tags": [
          "External_roles"
        ],
        "security": [
          {
            "bearerToken": []
          },
          {
            "apiKeyAuth": []
          }
        ],
        "summary": "Synchronize information about the external role by retrieving it from external source.",
        "description": "Synchronize information about the external role by retrieving it from external source.",
        "parameters": [
          {
            "name": "external_role_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "2XX": {
            "description": "Success result",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExternalRole"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ExternalRole": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "external_role_id": {
                "type": "string",
                "format": "uuid"
              },
              "groups": {
                "type": "object",
                "additionalProperties": {
                  "$ref": "#/components/schemas/ExternalRoleMapping"
                }
              },
              "kind": {
                "$ref": "#/components/schemas/ExternalRoleKind"
              },
              "last_synced": {
                "type": "string",
                "pattern": "^\\d{4}\\d{2}\\d{2}T\\d{2}\\d{2}\\d{2}Z$",
                "example": "20170509T070912Z"
              },
              "name": {
                "type": "string"
              },
              "source_id": {
                "type": "string",
                "format": "uuid"
              },
              "acct_id": {
                "type": "string",
                "format": "uuid"
              }
            },
            "required": [
              "external_role_id",
              "groups",
              "kind",
              "last_synced",
              "name",
              "source_id",
              "acct_id"
            ]
          }
        ]
      },
      "ExternalRoleMapping": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "users": {
                "$ref": "#/components/schemas/UserGroupRole"
              },
              "apps": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/AppPermissions"
                },
                "nullable": true
              }
            }
          }
        ]
      },
      "ExternalRoleKind": {
        "description": "Type of an external role.",
        "type": "string",
        "enum": [
          "ldap-group"
        ]
      },
      "UserGroupRole": {
        "description": "User's role(s) in a group.",
        "allOf": [
          {
            "type": "array",
            "uniqueItems": true,
            "items": {
              "$ref": "#/components/schemas/LegacyUserGroupRoleOrRoleId"
            }
          }
        ]
      },
      "AppPermissions": {
        "description": "Operations allowed to be performed by an app.\n\n\n\n          SIGN:\n\n\n          VERIFY:\n\n\n          ENCRYPT:\n\n\n          DECRYPT:\n\n\n          WRAPKEY:\n\n\n          UNWRAPKEY:\n\n\n          DERIVEKEY:\n\n\n          MACGENERATE:\n\n\n          MACVERIFY:\n\n\n          EXPORT:\n\n\n          MANAGE:\n\n\n          AGREEKEY:\n\n\n          MASKDECRYPT:\n\n\n          AUDIT:\n\n\n          TRANSFORM:\n\n\n          CREATE_SOBJECTS:\n\n\n          COPY_SOBJECTS:\n\n\n          ROTATE_SOBJECTS:\n\n\n          ACTIVATE_SOBJECTS:\n\n\n          REVOKE_SOBJECTS:\n\n\n          REVERT_SOBJECTS:\n\n\n          MOVE_SOBJECTS:\n\n\n          UPDATE_SOBJECTS_PROFILE:\n\n\n          UPDATE_SOBJECTS_ENABLED_STATE:\n\n\n          UPDATE_SOBJECT_POLICIES:\n\n\n          UPDATE_KEY_OPS:\n\n\n          DELETE_KEY_MATERIAL:\n\n\n          DELETE_SOBJECTS:\n\n\n          DESTROY_SOBJECTS:\n\n\n          RESTORE_EXTERNAL_SOBJECTS:\n\n\n          CALCULATE_DIGEST:\n\n\n          ENCAPSULATE:\n\n\n          DECAPSULATE:\n\n",
        "type": "string",
        "enum": [
          "SIGN",
          "VERIFY",
          "ENCRYPT",
          "DECRYPT",
          "WRAPKEY",
          "UNWRAPKEY",
          "DERIVEKEY",
          "MACGENERATE",
          "MACVERIFY",
          "EXPORT",
          "MANAGE",
          "AGREEKEY",
          "MASKDECRYPT",
          "AUDIT",
          "TRANSFORM",
          "CREATE_SOBJECTS",
          "COPY_SOBJECTS",
          "ROTATE_SOBJECTS",
          "ACTIVATE_SOBJECTS",
          "REVOKE_SOBJECTS",
          "REVERT_SOBJECTS",
          "MOVE_SOBJECTS",
          "UPDATE_SOBJECTS_PROFILE",
          "UPDATE_SOBJECTS_ENABLED_STATE",
          "UPDATE_SOBJECT_POLICIES",
          "UPDATE_KEY_OPS",
          "DELETE_KEY_MATERIAL",
          "DELETE_SOBJECTS",
          "DESTROY_SOBJECTS",
          "RESTORE_EXTERNAL_SOBJECTS",
          "CALCULATE_DIGEST",
          "ENCAPSULATE",
          "DECAPSULATE"
        ]
      },
      "LegacyUserGroupRoleOrRoleId": {
        "description": "Legacy user group role name or custom role id",
        "oneOf": [
          {
            "$ref": "#/components/schemas/LegacyUserGroupRole"
          },
          {
            "type": "string",
            "format": "uuid"
          }
        ]
      },
      "LegacyUserGroupRole": {
        "description": "Legacy user group role",
        "type": "string",
        "enum": [
          "GROUPAUDITOR",
          "GROUPADMINISTRATOR"
        ]
      }
    }
  }
}
````