GET login/apps/search
From Social ID Developers
Contents |
Description
Searches for Login Apps.
Resource URL
GET https://api.socialidnow.com/v1/marketing/login/apps/search
Parameters
URL Parameters
ids | optional | comma separated list of login app ids. Example: ids=1,2,3. |
---|---|---|
name | optional | login app name. |
name:like | optional | part of login app name. |
order | optional | search order. Default: ID ASC. |
page | optional | page number (each page contains page_size results). Default: 1. |
page_size | optional | maximum amount of results to be returned. Default: 8. |
roles | optional |
|
sign_in_policy_type | optional | login app sign in policy. Possible values: "open" or "require_any_role". |
sso | optional |
|
Authentication
This API requires Account authentication. See Authentication.
Response
Response Status
ok (200) | The request was successful. |
---|---|
unauthorized (401) | The authentication is wrong. See Authentication. |
internal_server_error (500) | An unknown error happened. |
Response Body
A successful search returns the following fields:
total | total amount of login apps found. |
---|---|
offset | amount of discarded login apps (page start). |
count | amount of login apps returned in this page. |
results | array with login app details. |
Examples
Without search parameters
Request
curl -iX GET 'https://api.socialidnow.com/v1/marketing/login/apps/search' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 200 Ok Status: 200
Response Body
{ "total": 3, "offset": 0, "count": 3, "results": [ { "id": 1, "name": "Login App A", "created_at": "2023-08-10T16:46:00Z", "updated_at": "2023-08-10T16:46:00Z" }, { "id": 2, "name": "Login App B", "created_at": "2023-08-10T16:47:00Z", "updated_at": "2023-08-10T16:47:00Z" }, { "id": 3, "name": "Login App C", "created_at": "2023-08-10T16:48:00Z", "updated_at": "2023-08-10T16:48:00Z" } ] }
With search parameters
Request
curl -iX GET 'https://api.socialidnow.com/v1/marketing/login/apps/search?page_size=1&page=2' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 200 Ok Status: 200
Response Body
{ "total": 3, "offset": 1, "count": 1, "results": [ { "id": 2, "name": "Login App B", "created_at": "2023-08-10T16:47:00Z", "updated_at": "2023-08-10T16:47:00Z" } ] }