Remove users from a user group

Request Params

• realm_id – The realm identifier

• usergroup_id – The user group identifier

• request header

  • Authorization {jwt}

• request body

  • JSON – {defaultEmail: “email@email.com“, defaultPhone: “+123456879“}

    • defaultEmail – The email to remove from the user group(can be null).

    • defaultPhone – The phone to remove from user group(can be null).

  • only one param can be null (defaultEmail or defaultPhone) in each request.

Request

DELETE https://afw.biocryptology.com/realm/v1/api/realms/{realm_id}/usergroup/{usergroup_id}

Responses

• OK 200 – User was removed from user group

• KO 400

  • Invalid group id - { message: "invalid_id_format" }

  • Invalid realm id - { message: “invalid_realm_id” }

  • Invalid email (empty, size or format)

    • { message: "invalid_allowed_user_email_size” }

    • { message: "invalid_allowed_user_phone_size” }

    • { message: "invalid_format_email_or_phone"” }

• KO 401 - No message attached

  • Token or JWT are invalid

  • Realm not found

• KO 404

  • User group not found - { message: "usergroup_not_found” }

  • User not found - { message: "user_not_found" }