Ownership request for a group

Location /api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/ownership/request/group:{groupID}

Point to start a flow with verification by code for adding the group as owner of the thing.

Authorization

header

Required: Yes

/api/apps/{appID}/things/VENDOR_THING_ID:{vendorThingID}/ownership/request/group:{groupID}

Description

Start a flow to add the group as the new thing owner.

Security

The administrator and the thing itself can add any group as a thing owner. A group member can add the group as a thing owner.

Note

This request requires empty body.

Headers

Name Required? type Description

Authorization Yes string Authorization header. OAuth2 Bearer token

URL Params

Name Required? type Description

groupID Yes string The ID of the group

Responses

200

Content-Type application/vnd.kii.ThingOwnershipRequestResponse+json

The ownership process has been started successfully.

Contents

Name	Type	Description
code	string	The code to complete the ownership process.

404

Content-Type application/vnd.kii.GroupNotFoundException+json

The group wasnot found.

Contents

404

Content-Type application/vnd.kii.ThingNotFoundException+json

The thing was not found.

Contents

Name	Type	Description
errorCode	string	Error code "THING_NOT_FOUND".
message	string	The error message.
field	string	The field used for searching the thing. This can be the "thingID" or "vendorThingID" field.
value	string	The field value used for searching the thing.
appID	string	The ID of the application.

409

Content-Type application/vnd.kii.ThingOwnershipAlreadyExistsException+json

The group is already an owner of the thing.

Contents

Name	Type	Description
errorCode	string	Error code "THING_OWNERSHIP_ALREADY_EXISTS".
message	string	The error message.
appID	string	The ID of the application.
thingID	string	The ID of the thing.
userID	string	The ID of the user.
groupID	string	The ID of the group.

401

Content-Type application/vnd.kii.UnauthorizedAccessException+json

Not authorized to add the group as an owner.

Contents

Name	Type	Description
errorCode	string	Error code "UNAUTHORIZED".
message	string	The error message.
authenticatedAppID	string	The authenticated appID.
authenticatedPrincipalID	string	The authenticated principal ID (userID or thingID).