Skip to content
Authrim

List source and target administrators for restore mapping

GET
/api/admin/tenant-backups/{operationId}/admin-mappings
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/tenant-backups/example/admin-mappings \
  --cookie authrim_admin_session=<authrim_admin_session>

Returns at most 100 validated source administrator IDs and 100 active same-tenant target administrators per page. Mapping data is available only for an import that selected Admin data. Internal validation positions and source credentials are omitted.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
operationId
required
string
/^[A-Za-z0-9_.:-]{1,256}$/

Query Parameters

Section titled “Query Parameters ”
after
string
<= 256 characters
targetAfter
string
<= 256 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Current mapping status and bounded source and target pages.

Media type application/json
object
status
required
object
revision
required
integer
state
required
string
Allowed values: open frozen
sourceCount
required
integer
mappedCount
required
integer
complete
required
boolean
digest
required
string
nullable /^[a-f0-9]{64}$/
key
additional properties
sources
required
object
entries
required
Array<object>
<= 100 items
object
sourceAdminId
required
string
targetAdminId
required
string
nullable
targetEmail
required
string
nullable
targetName
required
string
nullable
key
additional properties
nextCursor
required
string
done
required
boolean
key
additional properties
targets
required
object
entries
required
Array<object>
<= 100 items
object
id
required
string
email
required
string
name
required
string
nullable
key
additional properties
nextCursor
required
string
done
required
boolean
key
additional properties
key
additional properties
Example 
{
  "status": {
    "state": "open"
  }
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Section titled “409 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

503

Section titled “503 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}