/accesskeys/status

https://api.intserv.se/v1/accesskeys/status

Retrieves the current status of the latest change made on a given access key. This can be useful if tracking the propagation of a key to the affected access control systems is needed, after it has been created or updated.

Authentication Type: Integration API Key

📩 Request Body Parameters

Field	Type	Description
id	string(uuid)	Identifier of the access key to get status for.

Responses

✅ 200 OK Response Body Parameters

Sample Response

{
    "id": "e18574c0-0fde-475c-951f-265f0c2232ea",
    "status": "Applied",
    "systems_where_applied": 
    [
        {
            "system_id": "abc123-001",
            "applied_at": "2020-09-01T14:00:12Z"
        }
    ],
    "systems_where_pending":
    [
        {
            "system_id": "tqok23-001"
        }
    ],
    "systems_where_failed":
    [
        {
            "system_id": "hy64qw-002",
            "error_type": "CodeNotEnabled"
        }
    ]
}

Model Schema

StatusResponse {
    id (string(uuid)),
    status (string),
    systems_where_applied (array[AppliedSystem]),
    systems_where_pending (array[PendingSystem]),
    systems_where_failed (array[FailedSystem])
}

AppliedSystem {
    system_id (string),
    applied_at (string)
}

PendingSystem {
    system_id (string)
}

FailedSystem {
    system_id (string),
    error_type (string)
}

StatusResponse Model

Field	Type	Description
id	string(uuid)	Identifier of the access key.
status	string	Overall status. Can be one of the following values: NotApplied The access key is not applied to any systems (as supposed to). This status typically indicates that the access key does not have any access levels assigned. Applied The access key has been applied to all applicable systems. Pending Application of the latest changes is pending and has not yet been applied to any of the applicable systems. PartiallyApplied Application of the latest changes has been applied to some of the applicable systems, but is still pending for one or more systems. Failed Application of the access key has failed to one or more systems, due to an error.
systems_where_applied	array[AppliedSystem]	List of all systems where the access key has been applied, with related information.
systems_where_pending	array[PendingSystem]	List of all systems where the latest change on the access key is still pending.
systems_where_failed	array[FailedSystem]	List of all systems where the latest change could not be applied due to an error, with related information.

AppliedSystem Model

Field	Type	Description
system_id	string	Access control system identifier.
applied_at	string	Point in time when the change was applied.

PendingSystem Model

Field	Type	Description
system_id	string	Access control system identifier.

FailedSystem Model

Field	Type	Description
system_id	string	Access control system identifier.
error_type	string	Indicates the reason of the failure. See the error types section for a description of possible errors.

❌ 400 Bad Request

Access Key Error Types

Most of the errors types listed below indicates that a mismatch between IntServ Access and the access control system has occured. This can happen for example if configuration changes has been done manually in the access control system that hasn't yet been synchronized, and an access key has been updated between this gap.

Error Type	Description
AccessKeyInUse	The access key is already in use. This can occur if there is a user in the access control system (that has been managed outside IntServ Access) that owns additional access keys which conflicts with the access key.
AccessLevelNotFound	One or more access levels assigned to the access key does not exist in the system.
CodeNotEnabled	Usage of codes is not enabled in the access control system, and could therefore not accept the access key.
InvalidCodeSize	The code size does not match the size configured in the access control system.