OAA Runtime API

Create Secret Key

post

/oaa/runtime/totp/key/v1/

Use this API to create a TOTP secret key for a user.

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Details for creating a secret key for a user. userName is mandatory parameter. API call should be made with canonical uniqueUserId along with userName and groupName. If userName and groupName is unique, the call can also be made using userName and groupName.

Show Source

deviceName: string

Name of the device. This should be recognizable by the user.
groupName(required): string

User's group name.
uniqueUserId: string

Canonical ID of the user. If this is present, then it takes precedence over userId + groupId combination.
userName(required): string

User's username.

{
    "type":"object",
    "description":"Details for creating a secret key for a user. userName is mandatory parameter. API call should be made with canonical uniqueUserId along with userName and groupName. If userName and groupName is unique, the call can also be made using userName and groupName.",
    "required":[
        "groupName",
        "userName"
    ],
    "properties":{
        "groupName":{
            "type":"string",
            "description":"User's group name."
        },
        "userName":{
            "type":"string",
            "description":"User's username."
        },
        "deviceName":{
            "type":"string",
            "description":"Name of the device. This should be recognizable by the user."
        },
        "uniqueUserId":{
            "type":"string",
            "description":"Canonical ID of the user. If this is present, then it takes precedence over userId + groupId combination."
        }
    }
}

Root Schema : schema

Type: object

Show Source

deviceName: string

Name of the device. This should be recognizable by the user.
groupName(required): string

User's group name.
uniqueUserId: string

Canonical ID of the user. If this is present, then it takes precedence over userId + groupId combination.
userName(required): string

User's username.

{
    "type":"object",
    "description":"Details for creating a secret key for a user. userName is mandatory parameter. API call should be made with canonical uniqueUserId along with userName and groupName. If userName and groupName is unique, the call can also be made using userName and groupName.",
    "required":[
        "groupName",
        "userName"
    ],
    "properties":{
        "groupName":{
            "type":"string",
            "description":"User's group name."
        },
        "userName":{
            "type":"string",
            "description":"User's username."
        },
        "deviceName":{
            "type":"string",
            "description":"Name of the device. This should be recognizable by the user."
        },
        "uniqueUserId":{
            "type":"string",
            "description":"Canonical ID of the user. If this is present, then it takes precedence over userId + groupId combination."
        }
    }
}

Response

Supported Media Types

application/xml
application/json
text/plain

201 Response

Secret key has been created.

Root Schema : SecretKey

Type: object

A user's secret key.

Show Source

secret_key(required): string

Secret key of user.

{
    "type":"object",
    "description":"A user's secret key.",
    "required":[
        "secret_key"
    ],
    "properties":{
        "secret_key":{
            "description":"Secret key of user.",
            "type":"string"
        }
    }
}

400 Response

Bad Request

401 Response

Unauthorized

403 Response

Could not register secret key

Root Schema : SecretKeyAPIResponse

Type: object

Show Source

responseCode: string
responseMessage: string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

422 Response

Requested user information not found

Root Schema : SecretKeyAPIResponse

Type: object

Show Source

responseCode: string
responseMessage: string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

500 Response

Internal server error

Root Schema : SecretKeyAPIResponse

Type: object

Show Source

responseCode: string
responseMessage: string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Root Schema : SecretKeyAPIResponse

Type: object

Show Source

responseCode: string
responseMessage: string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

Examples

The following example shows a sample request and response for creating a Time-based One Time Password (TOTP) secret key for a user.

cURL Command to Create a TOTP in JSON Format

curl --location --request POST '<OAAService>/oaa/runtime/totp/key/v1/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '{
    "groupName": "financeapp",
    "userName": "user1",
    "uniqueUserId": "22a29071-16f2-4b69-a94c-73be672e34eb",
    "deviceName": "secretKeyApiTest2"
}'

Sample Response in JSON Format

{"secret_key":"2DXIBA4532JSI6WL"}

cURL Command to Create a TOTP in XML Format

curl --location --request POST '<OAAService>/oaa/runtime/totp/key/v1/' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '<?xml version="1.0" encoding="UTF-8" ?>
 <CreateSecretKeyRequest>
    <userName>user1</userName>
    <groupName>financeapp</groupName>
    <uniqueUserId>22a29071-16f2-4b69-a94c-73be672e34eb</uniqueUserId>
    <deviceName>secretKeyApiTest</deviceName>
 </CreateSecretKeyRequest>'

Sample Response in XML Format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <SecretKey>
     <secret_key>A56EWMZI2O62EPCV</secret_key>
 </SecretKey>