Identity V1 Rest API

📘

This API can also be accessed via the RequestHandler with app-id: IDN-V1.

🚧

This API id deprecated and superseded by the Identity V2 Rest APIs

The IdentityRestService APIs provides methods to manage the system identities.
Unless otherwise specified, identities with rest.identity permissions can access these APIs.

POST methods

Create User

• Description: This method allows to create a new user in the system.
• Method: POST
• API PATH: services/identity/v1/identities

Request

{
    "userName": "username",
    "password": "password",
    "passwordChangeNeeded": false,
    "passwordAuthEnabled": true,
    "permissions": [
        "rest.identity"
    ]
}

Responses

• 200 OK status
• 400 Bad Request (Password strenght requirements not satisfied)
• 500 Internal Server Error

Get User by Name

• Description: This method allows to get data about an user in the system. The only considered field is the userName.
• Method: POST
• API PATH: services/identity/v1/identities/byName

Request

{
    "userName": "username"
}

Responses

{
    "userName": "kura.user.username",
    "passwordAuthEnabled": false,
    "passwordChangeNeeded": false,
    "permissions": []
}

• 200 OK status
• 500 Internal Server Error

GET methods

Get defined permissions

• Description: This method allows you to get the list of the permissions defined in the system
• Method: GET
• API PATH: services/identity/v1/definedPermissions

No specific permission is required to access this resource.

Responses

{
    "permissions": [
        "rest.command",
        "rest.inventory",
        "rest.configuration",
        "rest.tamper.detection",
        "rest.security",
        "kura.cloud.connection.admin",
        "rest.position",
        "kura.packages.admin",
        "kura.device",
        "rest.wires.admin",
        "kura.admin",
        "rest.keystores",
        "rest.assets",
        "rest.system",
        "kura.maintenance",
        "kura.wires.admin",
        "rest.identity"
    ]
}

• 200 OK status
• 500 Internal Server Error

Get users configuration

• Description: This method allows you to get the list of the users and their configuration on the system.
• Method: GET
• API PATH: services/identity/v1/identities

Responses

{
    "userConfig": [
        {
            "userName": "admin",
            "passwordAuthEnabled": true,
            "passwordChangeNeeded": false,
            "permissions": [
                "kura.admin"
            ]
        },
        {
            "userName": "appadmin",
            "passwordAuthEnabled": true,
            "passwordChangeNeeded": true,
            "permissions": [
                "kura.cloud.connection.admin",
                "kura.packages.admin",
                "kura.wires.admin"
            ]
        }
    ]
}

• 200 OK status
• 500 Internal Server Error

Get password requirements

• Description: This method allows you to get the password requirements.
• Method: GET
• API PATH: services/identity/v1/passwordRequirements

No specific permission is required to access this resource.

Responses

{
    "passwordMinimumLength": 8,
    "passwordRequireDigits": false,
    "passwordRequireSpecialChars": false,
    "passwordRequireBothCases": false
}

• 200 OK status
• 500 Internal Server Error

PUT methods

Update User

• Description: This method allows to update an existing user in the system.
• Method: PUT
• API PATH: services/identity/v1/identities

Request

{
    "userName": "username",
    "password": "password",
    "passwordChangeNeeded": false,
    "passwordAuthEnabled": true,
    "permissions": [
        "rest.identity"
    ]
}

Responses

• 200 OK status
• 400 Bad Request (Password strenght requirements not satisfied)
• 500 Internal Server Error

DELETE methods

Delete User

• Description: This method allows to delete an existing user in the system. The only considered field is the userName.
• Method: DELETE
• API PATH: services/identity/v1/identities

Request

{
    "userName": "username",
}

Responses

• 200 OK status
• 500 Internal Server Error