Conditions
-
Max 10 users at a time.
-
Repeated pairs(same email and/or phone) are automatically removed when processing and ignored.
-
i.e. [ {defaultEmail: “email1@email.com“}, {defaultEmail: “email1@email.com“}, … {defaultEmail: “email22@email.com“}}]
-
if the request has 11 entries and has two or more entries that are equal they will be merged and the limit won’t be reached.
-
it will be processed as: [ {defaultEmail: “email1@email.com“}, … {defaultEmail: “email22@email.com“} }
-
-
Request Params
-
realm_id – The realm identifier
-
usergroup_id – The user group identifier
-
request header
-
Authorization {jwt}
-
-
request body
-
List: [ { defaultEmail: “email1@email.com“, defaultPhone: “+123456789“ }, { defaultEmail: “email2@email.com“, defaultPhone: “+1234564895“ }, …]
-
defaultEmail – The email to remove from the user group(can be null)
-
defaultPhone – The phone to remove from the user group(can be null)
-
only one param can be null (defaultEmail or defaultPhone)
-
-
Request
DELETE https://afw.biocryptology.com/realm/v1/api/realms/{realm_id}/usergroup/{usergroup_id}/users
Responses
- OK 200 - Users were added to user group
- KO 400
-
Invalid group id - { message: "invalid_id_format" }
-
Invalid realm id - { message: “invalid_realm_id” }
-
Too many users(more than 10) - { message: “too_many_users_to_remove“ }
-
Invalid email (empty, size or format) - Returns a list with the users that couldn’t be removed.
-
{ users: [ { defaultEmail: “e@e.m“, message: "invalid_allowed_user_email_size” }, …] }
-
{ users: [ { defaultPhone: “+1“, message: "invalid_allowed_user_phone_size” }, …] }
-
{ users: [ { defaultEmail: “email1email..com“, 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”}
-
Users not found - { users: [ { defaultEmail: “email1email..com“, message: "user_not_found” } …] }