Skip to main content

users-changelog-tpw-operator

Release 8.0​

RDTP-19650 / RDTP-21963​

What's Deprecated​

GET /users/{userUid}/depot​

Retrieve Depot

PUT /users/{userUid}/depot​

Update Depot

What's Changed​

All paths /users/\{userUid\}/*​
Parameters:​

Changed: userUid in path

Unique identifier of the end-user, either

  • the identifier (thingparkID) assigned to the end-user at creation
  • the OpenID subject claim sub of an ID Token issued by the identity provider
  • the string 'me' to reference the authenticated end-user requesting the API
  • the sequential integer (UID) assigned to the end-user at creation
GET /users/{userUid}/contexts​

Retrieve Contexts

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property brief (array)

      Changed items (object):

      New required properties:

      • subscriberID

      • Added property subscriberID (string)

        Subscriber ID

Release 7.3​

RDTP-16527​

What's Changed​

All operations​
Parameters:​

Changed: userUid in path

Unique identifier of the user, either

  • the sequential integer (UID) assigned to the user at creation
  • the identifier (thingparkID) assigned to the user at creation
  • the OpenID subject claim sub of an ID Token issued by the identity provider (new)

RDTP-19834​

What's Changed​

GET /users/{userUid}​

Retrieve User

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • occContext
PUT /users/{userUid}​

Update User

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • occContext
PUT /users/{userUid}/restricted​

Update Restricted

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

The following properties are now optional:

  • occContext

RDTP-21689​

What's Changed​

GET /users/{userUid}​

Retrieve User

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Deprecated property apiOnly (boolean)

    true if the user account is specifically designed to be used by an application. apiOnly user accounts are not subject to password expiration.

    This property must no longer be used: service accounts must be used to access the API.

PUT /users/{userUid}​

Update User

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Deprecated property apiOnly (boolean)

    true if the user account is specifically designed to be used by an application. apiOnly user accounts are not subject to password expiration.

    This property must no longer be used: service accounts must be used to access the API.

Release 7.2​

RDTP-8479​

What's Changed​

GET /users/{userUid}/contexts​

Retrieve Contexts

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property brief (array)

      Changed items (object):

      • Added property domainRestrictions (object)

        User's domain restrictions:

        • If no domain restrictions are defined, the user can access all cross-domain resources and all domain-specific resources
        • Else, the user can access all cross-domain resources and only domain-specific resources matching the domain restrictions

        • Property and (array)

          A resource matches if it matches all and items.

          Items (object):

          A resource matches if it is associated with a domain satisfying the following requirements:

          • The group name of the resource domain is group.name (exact match)
          • If type is PREFIX:
            • The name of the resource domain is prefixed with name
          • Else: (type is FULL)
            • The name of the resource domain is name (exact match)

          • Property type (string)

            Type of domain restriction:

            • FULL: restriction on full domain
            • PREFIX: restriction on domain prefix

            Enum values:

            • FULL
            • PREFIX

          • Property name (string)

            Name of the full domain or domain prefix

          • Property group (object)

            Domain group associated with the domain restriction

            • Property name (string)

              Name of the domain group

Release 7.1​

No change

Release 7.0​

RDTP-15723​

What's Deprecated​

POST /users/{userUid}/tmpCredential​

This endpoint must no longer be used: the associated feature is no more available in the product.

GET /users/{userUid}​
Return Type:​

Changed response : 200 OK

  • Deprecated property facebookID (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property googleID (string)

    This property must no longer be used: the associated feature is no more available in the product.

PUT /users/{userUid}​
Request:​

  • Deprecated property facebookID (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property googleID (string)

    This property must no longer be used: the associated feature is no more available in the product.

Return Type:​

Changed response : 200 OK

  • Deprecated property facebookID (string)

    This property must no longer be used: the associated feature is no more available in the product.

  • Deprecated property googleID (string)

    This property must no longer be used: the associated feature is no more available in the product.

Release 6.1​

No change

Release 6.0​

RDTP-10108​

What's Changed​

GET /users/{userUid}​

Retrieve User

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property apiOnly (boolean)

    true if the user account is specifically designed to be used by an application to make automatic requests to the SMP platform. apiOnly user accounts are not subject to password expiration.

PUT /users/{userUid}​

Update User

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Added property apiOnly (boolean)

    true if the user account is specifically designed to be used by an application to make automatic requests to the SMP platform. apiOnly user accounts are not subject to password expiration.

RDTP-2443​

What's Changed​

GET /users/{userUid}​

Retrieve User

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Property occContext is deprecated
PUT /users/{userUid}​

Update User

Parameters:​

Removed: force in query

OCC Context is always ignored.

Request:​
  • Property occContext is deprecated
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Property occContext is deprecated
PUT /users/{userUid}/restricted​

Update Restricted

Parameters:​

Removed: force in query

OCC Context is always ignored.

Request:​
  • Property occContext is deprecated
Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Property occContext is deprecated

RDTP-2488​

What's Changed​

GET /users/{userUid}/contexts​

Retrieve Contexts

Return Type:​

Changed response : 200 OK

Successful UPDATE or RETRIEVE

  • Changed property briefs (object)

    • Changed property brief (array)

      Changed items (object):

      New required properties:

      • grantedPermissions

      • Added property grantedPermissions (object)

        • Property permission (array)

          Items (string):

          Enum values:

          • x
          • a
          • ra
          • rc

      • Added property ctxHref (string)

        User HREF in Subscriber context

Release 5.2.2​

No change

Release 5.1​

General​

No change

Release 5.0.1​

General​

No change

Last updated on
Copyright © 2024 Actility
On this page