On this page

    1. Home
    2. API
    3. API Reference
    4. Device
    5. Remove Association

    Remove Association

    This endpoint allows you to terminate a device association. This applies to devices you have shared with other networks, devices shared with you, or devices currently in the adoption process. Once the association is removed, the related permissions and network access are revoked.


    POST /device/remove-association

    Revoke a share or adoption association based on its unique code.

    Request

    POST /device/remove-association

    Headers:

    {
      "Host": "api.bringyour.com",
      "Content-Type": "application/json",
      "Authorization": "Bearer YOUR_JWT_TOKEN"
    }

    Body:

    {
      "code": "string"
    }
    FieldTypeDescription
    codestringRequired. The unique share or adopt code associated with the link you wish to remove.

    Response

    200 Success

    Status: 200 OK

    Content-Type: application/json

    {
      "error": {
        "message": "string"
      }
    }
    FieldTypeDescription
    errorobjectDetails on failure if the association could not be removed (can be null).
    error.messagestringA human-readable error message.

    Example

    HTTP Request

    POST /device/remove-association HTTP/1.1
    Host: api.bringyour.com
    Content-Type: application/json
    Authorization: Bearer YOUR_JWT_TOKEN
     
    {
      "code": "SHARE-1234-ABCD"
    }

    Successful HTTP Response

    {
      "error": null
    }


    Powered by Sudoc v2.5.0
    Hide table of contents