Application Users
Get Application User
Get an application user by ID.
Request
GET /app/users/{id}
Response
Returns a 200 response on success
Fields
Name | Type | Description |
---|---|---|
id | string | unique application user resource identifier |
uri | string | URI of the application user API resource |
identity_provider | IdentityProvider | identity provider that the user authenticated with |
provider_user_id | string | unique user identifier |
username | string | user username |
email | string | user email |
name | string | user common name |
created_at | string | timestamp when the user was created in RFC 3339 format |
last_active | string | timestamp when the user was last active in RFC 3339 format |
last_login | string | timestamp when the user last signed-in in RFC 3339 format |
IdentityProvider fields
Name | Type | Description |
---|---|---|
name | string | name of the identity provider (e.g. Google) |
url | string | URL of the identity provider (e.g. https://accounts.google.com) |
Delete Application User
Delete an application user by ID.
Request
DELETE /app/users/{id}
Response
Returns a 204 response with no body on success
List Application Users
List all application users for this account.
Request
GET /app/users
Response
Returns a 200 response on success
Fields
Name | Type | Description |
---|---|---|
application_users | ApplicationUser | list of all application users on this account |
uri | string | URI of the application user list API resource |
next_page_uri | string | URI of the next page, or null if there is no next page |
ApplicationUser fields
Name | Type | Description |
---|---|---|
id | string | unique application user resource identifier |
uri | string | URI of the application user API resource |
identity_provider | IdentityProvider | identity provider that the user authenticated with |
provider_user_id | string | unique user identifier |
username | string | user username |
email | string | user email |
name | string | user common name |
created_at | string | timestamp when the user was created in RFC 3339 format |
last_active | string | timestamp when the user was last active in RFC 3339 format |
last_login | string | timestamp when the user last signed-in in RFC 3339 format |
IdentityProvider fields
Name | Type | Description |
---|---|---|
name | string | name of the identity provider (e.g. Google) |
url | string | URL of the identity provider (e.g. https://accounts.google.com) |