Users

List Users

Retrieve a list of users in the authorized scope.

List Users

GET https://ident.provide.services/api/v1/users

Returns a list of users within the authorized scope; requires elevated permissions and will return 403 Forbidden to any user without sufficient permissions.

Headers

Name	Type	Description
authorization	string	bearer scoped to an Application , Organization or User

200

[
    {
        "id": "15679071-4a5e-41e3-a495-5d93b478257b",
        "created_at": "2021-03-24T09:37:55.995881Z",
        "name": "John Young",
        "first_name": "John",
        "last_name": "Young",
        "email": "[e-mail]",
        "permissions": 415,
        "privacy_policy_agreed_at": "2021-02-09T14:37:33.384Z",
        "terms_of_service_agreed_at": "2021-02-09T14:37:33.384Z"
    },
    {
        "id": "45a64d9f-3996-4ab0-9de6-2e8b44ef119c",
        "created_at": "2021-02-09T14:37:28.610184Z",
        "name": Bob Crippen,
        "first_name": "Bob",
        "last_name": "Crippen",
        "email": "[e-mail]",
        "permissions": 415,
        "privacy_policy_agreed_at": "2021-02-09T14:37:33.384Z",
        "terms_of_service_agreed_at": "2021-02-09T14:37:34.601Z"
    }
]

curl

curl -i \
     -H 'authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \
     https://ident.provide.services/api/v1/users
HTTP/2 200

Response JSON

[
    {
        "id": "15679071-4a5e-41e3-a495-5d93b478257b",
        "created_at": "2021-03-24T09:37:55.995881Z",
        "name": "John Young",
        "first_name": "John",
        "last_name": "Young",
        "email": "[e-mail]",
        "permissions": 415,
        "privacy_policy_agreed_at": "2021-02-09T14:37:33.384Z",
        "terms_of_service_agreed_at": "2021-02-09T14:37:33.384Z"
    },
    {
        "id": "45a64d9f-3996-4ab0-9de6-2e8b44ef119c",
        "created_at": "2021-02-09T14:37:28.610184Z",
        "name": Bob Crippen,
        "first_name": "Bob",
        "last_name": "Crippen",
        "email": "[e-mail]",
        "permissions": 415,
        "privacy_policy_agreed_at": "2021-02-09T14:37:33.384Z",
        "terms_of_service_agreed_at": "2021-02-09T14:37:34.601Z"
    }
]

Create User

Create a new user.

Create User

POST https://ident.provide.services/api/v1/users

Creates a new user.

Authorization is not required to create a user. To create a virtual user, omit the password parameter and include an Application scoped bearer token as authorization with the request.

Headers

Name	Type	Description
authorization	string	bearer ofApplication if a virtual user is being created

Request Body

Name	Type	Description
email*	string	email address of the User to be created
password	string	password of the user to be created. If null and an application scoped bearer token is passed, the resulting User will be a virtual user
first_name*	string	first name of the User to be created
last_name*	string	last name of the User to be created

201

{
    "id": "49a02f33-33f2-4d69-a301-ffb1933e77cc",
    "created_at": "2021-02-09T14:37:33.384Z",
    "name": "John Young",
    "first_name": "John",
    "last_name": "Young",
    "email": "[e-mail]",
    "permissions": 415,
    "privacy_policy_agreed_at": "2021-02-09T14:37:33.384Z",
    "terms_of_service_agreed_at": "2021-02-09T14:37:33.384Z"
}

curl

curl --location --request POST 'https://ident.provide.services/api/v1/users' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "[e-mail]",
    "first_name": "Shanie",
    "last_name": "Jaskolski",
    "password": "pass4testuser$"
}'

Response JSON

{
    "id": "49a02f33-33f2-4d69-a301-ffb1933e77cc",
    "created_at": "2021-02-09T14:37:33.384Z",
    "name": "John Young",
    "first_name": "John",
    "last_name": "Young",
    "email": "[e-mail]",
    "permissions": 415,
    "privacy_policy_agreed_at": "2021-02-09T14:37:33.384Z",
    "terms_of_service_agreed_at": "2021-02-09T14:37:33.384Z"
}

Get User Details

Retrieve details for a user.

Get User Detail

GET https://ident.provide.services/api/v1/users/:id

Returns details for a specified user

Path Parameters

Name	Type	Description
id	string	id of the target User

Headers

Name	Type	Description
authorization	string	bearer scoped to an Application , Organization or User

200

{
    "id": "15679071-4a5e-41e3-a495-5d93b478257b",
    "created_at": "2021-03-24T09:37:55.995881Z",
    "name": "John Young",
    "first_name": "John",
    "last_name": "Young",
    "email": "[e-mail]",
    "permissions": 415,
    "privacy_policy_agreed_at": "2021-02-09T14:37:33.384Z",
    "terms_of_service_agreed_at": "2021-02-09T14:37:33.384Z"
    "metadata": {
        "user_id": "15679071-4a5e-41e3-a495-5d93b478257b",
        "name": "John Young",
        "email": "[e-mail]",
        "email_verified": false,
        "app_metadata": {
            "ident_user_id": "15679071-4a5e-41e3-a495-5d93b478257b"
        },
        "user_metadata": {}
    }
}

curl

curl -i \
     -H 'authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \
     https://ident.provide.services/api/v1/users/efef1044-4958-43bc-903b-28f2bb938037
HTTP/2 200

Response JSON

{
    "id": "8452d9c2-ac28-4993-a4e8-8f5b426f5c01",
    "created_at": "2020-12-16T05:13:40.240119Z",
    "name": "Shanie Jaskolski",
    "first_name": "Shanie",
    "last_name": "Jaskolski",
    "email": "[e-mail]",
    "permissions": 1048991,
    "privacy_policy_agreed_at": "2020-12-16T05:13:41.967Z",
    "terms_of_service_agreed_at": "2020-12-16T05:13:48.968Z",
    "metadata": {
        "user_id": "auth0|8452d9c2-ac28-4993-a4e8-8f5b426f5c01",
        "name": "Shanie Jaskolski",
        "email": "[e-mail]",
        "email_verified": false,
        "app_metadata": {
            "ident_user_id": "8452d9c2-ac28-4993-a4e8-8f5b426f5c01"
        },
        "user_metadata": {}
    }
}

URL Parameters

Parameter	Description
id	id of the User

Update User

Update a user.

Update User

PUT https://ident.provide.services/api/v1/users/:id

Updates a specified user

Path Parameters

Name	Type	Description
user_id	string	id of the User to be updated

Headers

Name	Type	Description
authorization	string	bearer scoped to an Application, Organization or User

Request Body

Name	Type	Description
email	string	email of User to be updated
first_name	string	first name of User to be updated
last_name	string	last name of User to be updated

204

[]

curl

curl -XPUT -i \
     -H 'content-type: application/json' \
     -H 'authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \
     https://ident.provide.services/api/v1/users/efef1044-4958-43bc-903b-28f2bb938037 \
     -d '{}'
HTTP/2 204

URL Parameters

Parameter	Description
id	id of the User

Delete User

Delete a user.

curl

curl -XDELETE -i \
     -H 'content-type: application/json' \
     -H 'authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \
     https://ident.provide.services/api/v1/users/efef1044-4958-43bc-903b-28f2bb938037 \
HTTP/2 204