Fetch

GET /scope/admin

Signature authentication & Bearer authentication & Drive authentication & Drive secret key & Guest authentication & Guest secret key

Query parameters

id string(uuid) Required
page integer(int32)
size integer(int32)

Responses

200 */*

OK
Hide response attributes Show response attributes object
- status string
  
  Values are 100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 EARLY_HINTS, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 425 TOO_EARLY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, or 511 NETWORK_AUTHENTICATION_REQUIRED.
- code integer(int32)
- message string
- data object
  
  Hide data attributes Show data attributes object
  
  profile object
  
  Hide profile attributes Show profile attributes object
  
  avatar string
  
  id string(uuid)
  
  status string
  
  Values are SUSPENDED, ACTIVE, DEACTIVATED, BUSINESS_DEACTIVATED, DELETED, BUSINESS_DELETED, or HAS_REPORTED_ISSUES.
  
  role string
  
  Values are USER, PROVIDER, ASSOCIATE_PROVIDER, BUSINESS, SUPER_ADMIN, ADMIN, MANAGER, or TEAM.
  
  first_name string
  
  last_name string
  
  email_address string
  
  created_at string(date-time)
  
  updated_at string(date-time)
  
  account_created_at string
  
  account_updated_at string
  
  profile_created_at string
  
  profile_updated_at string
  
  email_confirmed_at string
  
  password_updated_at string
  
  last_signed_in string
  
  emp_id string
  
  should_resend_invite boolean
  
  team object
  
  Hide team attributes Show team attributes object
  
  role string
  
  Values are USER, PROVIDER, ASSOCIATE_PROVIDER, BUSINESS, SUPER_ADMIN, ADMIN, MANAGER, or TEAM.
  
  position string
  
  department string
  
  cluster array[object]
  
  Hide cluster attributes Show cluster attributes object
  
  id integer(int64)
  
  scope string
  
  Values are USER, PROVIDER, ASSOCIATE_PROVIDER, BUSINESS, PAYMENT, SUPPORT, PRODUCT, ADMIN, or GUEST.
  
  createdAt string
  
  updatedAt string
  
  permissions array[object]
  
  Hide permissions attributes Show permissions attributes object
  
  id integer(int64)
  
  createdAt string
  
  updatedAt string
  
  expiration string
  
  permission string
  
  Values are WRITE, READ, UPDATE, or DELETE.
  
  specific array[object]
  
  Hide specific attributes Show specific attributes object
  
  account string
  
  name string
  
  scopes array[object]
  
  Hide scopes attributes Show scopes attributes object
  
  id integer(int64)
  
  scope string
  
  Values are USER, PROVIDER, ASSOCIATE_PROVIDER, BUSINESS, PAYMENT, SUPPORT, PRODUCT, ADMIN, or GUEST.
  
  createdAt string
  
  updatedAt string
  
  permissions array[object]
  
  Hide permissions attributes Show permissions attributes object
  
  id integer(int64)
  
  createdAt string
  
  updatedAt string
  
  expiration string
  
  permission string
  
  Values are WRITE, READ, UPDATE, or DELETE.
  
  activities array[object]
  
  Hide activities attributes Show activities attributes object
  
  id integer(int64)
  
  activity string
  
  associated string
  
  tag string
  
  label string
  
  header string
  
  createdAt string(date-time)
  
  updatedAt string(date-time)
  
  auth object
  
  Hide auth attributes Show auth attributes object
  
  method string
  
  level string
  
  devices array[object]
  
  Hide devices attributes Show devices attributes object
  
  name string
  
  platform string
  
  count integer(int32)
  
  revoked boolean
  
  has_mfa boolean
  
  must_have_mfa boolean
  
  structure object
  
  Hide structure attributes Show structure attributes object
  
  id string
  
  name string
  
  position string
  
  image string
  
  role string
  
  Values are USER, PROVIDER, ASSOCIATE_PROVIDER, BUSINESS, SUPER_ADMIN, ADMIN, MANAGER, or TEAM.
  
  children array[object]
  
  mfa object
  
  Hide mfa attributes Show mfa attributes object
  
  createdAt string(date-time)
  
  updatedAt string(date-time)
  
  id string
  
  challenges array[object]
  
  Hide challenges attributes Show challenges attributes object
  
  createdAt string(date-time)
  
  updatedAt string(date-time)
  
  verifiedAt string(date-time)
  
  name string
  
  platform string
  
  osv string
  
  os string
  
  ipAddress string
  
  host string
  
  localHost string
  
  device string
  
  id string
  
  sessions array[object]
  
  Hide sessions attributes Show sessions attributes object
  
  name string
  
  platform string
  
  osv string
  
  os string
  
  method string
  
  Values are TOKEN, PASSWORD, NONE, PASSWORD_CHANGE, or MFA.
  
  level string
  
  Values are LEVEL_0, LEVEL_1, or LEVEL_2.
  
  ipAddress string
  
  host string
  
  device string
  
  id string
  
  revoked boolean
  
  createdAt string(date-time)
  
  updatedAt string(date-time)
  
  refreshTokens array[object]
  
  Hide refreshTokens attributes Show refreshTokens attributes object
  
  id string
  
  token string
  
  updatedAt string(date-time)
  
  createdAt string(date-time)
  
  revoked boolean
  
  analysis object
  
  Hide analysis attributes Show analysis attributes object
  
  status array[object]
  
  Hide status attributes Show status attributes object
  
  value integer(int64)
  
  amount number
  
  color string
  
  image string
  
  label string
  
  years array[integer(int32)]
  
  auth array[object]
  
  Hide auth attributes Show auth attributes object
  
  value integer(int64)
  
  amount number
  
  color string
  
  image string
  
  label string

GET /scope/admin

curl \
 --request GET 'https://sandbox.serchservice.com/api/v1/scope/admin?id=string' \
 --header "X-Serch-Signed: $API_KEY" \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-Serch-Drive-Api-Key: $API_KEY" \
 --header "X-Serch-Drive-Secret-Key: $API_KEY" \
 --header "X-Serch-Guest-Api-Key: $API_KEY" \
 --header "X-Serch-Guest-Secret-Key: $API_KEY"

Response examples (200)

{
  "status": "100 CONTINUE",
  "code": 42,
  "message": "string",
  "data": {
    "profile": {
      "avatar": "string",
      "id": "string",
      "status": "SUSPENDED",
      "role": "USER",
      "first_name": "string",
      "last_name": "string",
      "email_address": "string",
      "created_at": "2025-05-04T09:42:00Z",
      "updated_at": "2025-05-04T09:42:00Z",
      "account_created_at": "string",
      "account_updated_at": "string",
      "profile_created_at": "string",
      "profile_updated_at": "string",
      "email_confirmed_at": "string",
      "password_updated_at": "string",
      "last_signed_in": "string",
      "emp_id": "string",
      "should_resend_invite": true
    },
    "team": {
      "role": "USER",
      "position": "string",
      "department": "string",
      "cluster": [
        {
          "id": 42,
          "scope": "USER",
          "createdAt": "string",
          "updatedAt": "string",
          "permissions": [
            {
              "id": 42,
              "createdAt": "string",
              "updatedAt": "string",
              "expiration": "string",
              "permission": "WRITE"
            }
          ]
        }
      ],
      "specific": [
        {
          "account": "string",
          "name": "string",
          "scopes": [
            {
              "id": 42,
              "scope": "USER",
              "createdAt": "string",
              "updatedAt": "string",
              "permissions": [
                {
                  "id": 42,
                  "createdAt": "string",
                  "updatedAt": "string",
                  "expiration": "string",
                  "permission": "WRITE"
                }
              ]
            }
          ]
        }
      ]
    },
    "activities": [
      {
        "id": 42,
        "activity": "string",
        "associated": "string",
        "tag": "string",
        "label": "string",
        "header": "string",
        "createdAt": "2025-05-04T09:42:00Z",
        "updatedAt": "2025-05-04T09:42:00Z"
      }
    ],
    "auth": {
      "method": "string",
      "level": "string",
      "devices": [
        {
          "name": "string",
          "platform": "string",
          "count": 42,
          "revoked": true
        }
      ],
      "has_mfa": true,
      "must_have_mfa": true
    },
    "structure": {
      "id": "string",
      "name": "string",
      "position": "string",
      "image": "string",
      "role": "USER",
      "children": [
        {}
      ]
    },
    "mfa": {
      "createdAt": "2025-05-04T09:42:00Z",
      "updatedAt": "2025-05-04T09:42:00Z",
      "id": "string"
    },
    "challenges": [
      {
        "createdAt": "2025-05-04T09:42:00Z",
        "updatedAt": "2025-05-04T09:42:00Z",
        "verifiedAt": "2025-05-04T09:42:00Z",
        "name": "string",
        "platform": "string",
        "osv": "string",
        "os": "string",
        "ipAddress": "string",
        "host": "string",
        "localHost": "string",
        "device": "string",
        "id": "string"
      }
    ],
    "sessions": [
      {
        "name": "string",
        "platform": "string",
        "osv": "string",
        "os": "string",
        "method": "TOKEN",
        "level": "LEVEL_0",
        "ipAddress": "string",
        "host": "string",
        "device": "string",
        "id": "string",
        "revoked": true,
        "createdAt": "2025-05-04T09:42:00Z",
        "updatedAt": "2025-05-04T09:42:00Z",
        "refreshTokens": [
          {
            "id": "string",
            "token": "string",
            "updatedAt": "2025-05-04T09:42:00Z",
            "createdAt": "2025-05-04T09:42:00Z",
            "revoked": true
          }
        ]
      }
    ],
    "analysis": {
      "status": [
        {
          "value": 42,
          "amount": 42.0,
          "color": "string",
          "image": "string",
          "label": "string"
        }
      ],
      "years": [
        42
      ],
      "auth": [
        {
          "value": 42,
          "amount": 42.0,
          "color": "string",
          "image": "string",
          "label": "string"
        }
      ]
    }
  }
}