POST login/users
From Social ID Developers
(Difference between revisions)
(moved POST login/users to POST login/users PT-BR) |
(→Parameters) |
||
| (2 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | == Description == | |
| + | |||
| + | Creates a new user manually, given username and/or e-mail. | ||
| + | |||
| + | == Resource URL == | ||
| + | |||
| + | POST https://api.socialidnow.com/v1/marketing/login/users | ||
| + | |||
| + | == Parameters == | ||
| + | |||
| + | === JSON Parameters === | ||
| + | |||
| + | {| | ||
| + | ! align="left" width="200px" | user | ||
| + | | width="200px" | required | ||
| + | | a hash in the format field:value, with the necessary fields to create an user: | ||
| + | |- | ||
| + | ! align="left" width="180px" style="padding-left: 20px" | username | ||
| + | | width="200px" | optional | ||
| + | | username. | ||
| + | |- | ||
| + | ! align="left" width="180px" style="padding-left: 20px" | email_address | ||
| + | | width="200px" | optional | ||
| + | | user e-mail address. | ||
| + | |- | ||
| + | ! align="left" width="180px" style="padding-left: 20px" | password | ||
| + | | width="200px" | optional | ||
| + | | user password. | ||
| + | |} | ||
| + | |||
| + | == Authentication == | ||
| + | |||
| + | This API requires Login App authentication. See [[Authentication]]. | ||
| + | |||
| + | == Response == | ||
| + | |||
| + | ==== Response Status ==== | ||
| + | {| | ||
| + | ! align="left" width="200px" | created (201) | ||
| + | | The user was created successfully. | ||
| + | |- | ||
| + | ! align="left" width="200px" | bad_request (400) | ||
| + | | Some required parameter was not informed. | ||
| + | |- | ||
| + | ! align="left" width="200px" | unauthorized (401) | ||
| + | | The authentication is wrong. See [[Authentication]]. | ||
| + | |- | ||
| + | ! align="left" width="200px" | unprocessable_entity (422) | ||
| + | | Validation error in the field "user". | ||
| + | |- | ||
| + | ! align="left" width="200px" | internal_server_error (500) | ||
| + | | An unknown error happened. | ||
| + | |} | ||
| + | |||
| + | == Examples == | ||
| + | |||
| + | === Request === | ||
| + | |||
| + | Creates a new user. | ||
| + | |||
| + | curl -iX POST 'https://api.socialidnow.com/v1/marketing/login/users' \ | ||
| + | -d '{ | ||
| + | "user": { | ||
| + | "username":"new_user", | ||
| + | "email_address":"new_user@user_domain.com", | ||
| + | "password":"new_user_secret" | ||
| + | } | ||
| + | }' \ | ||
| + | -H 'Content-type: application/json' \ | ||
| + | --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf | ||
| + | |||
| + | === Response === | ||
| + | |||
| + | ==== Response Headers ==== | ||
| + | |||
| + | HTTP/1.1 201 Created | ||
| + | Location: 'https://api.socialidnow.com/v1/marketing/login/users/341' | ||
| + | Status: 201 | ||
Latest revision as of 14:34, 11 April 2022
Contents |
Description
Creates a new user manually, given username and/or e-mail.
Resource URL
POST https://api.socialidnow.com/v1/marketing/login/users
Parameters
JSON Parameters
| user | required | a hash in the format field:value, with the necessary fields to create an user: |
|---|---|---|
| username | optional | username. |
| email_address | optional | user e-mail address. |
| password | optional | user password. |
Authentication
This API requires Login App authentication. See Authentication.
Response
Response Status
| created (201) | The user was created successfully. |
|---|---|
| bad_request (400) | Some required parameter was not informed. |
| unauthorized (401) | The authentication is wrong. See Authentication. |
| unprocessable_entity (422) | Validation error in the field "user". |
| internal_server_error (500) | An unknown error happened. |
Examples
Request
Creates a new user.
curl -iX POST 'https://api.socialidnow.com/v1/marketing/login/users' \ -d '{ "user": { "username":"new_user", "email_address":"new_user@user_domain.com", "password":"new_user_secret" } }' \ -H 'Content-type: application/json' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 201 Created Location: 'https://api.socialidnow.com/v1/marketing/login/users/341' Status: 201
