Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

CONNECT data services developer documentation

Access Control

  • Last UpdatedSep 08, 2023
  • 4 minute read

Get OMF Connection Access Control List

Gets the AccessControlList for the specified OmfConnection.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/omfConnections/{omfConnectionId}/accesscontrol

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string omfConnectionId
OMF connection identifier.

Response

Status Code Body Type Description
200 AccessControlList The AccessControlList
401 ErrorResponseBody Unauthorized
403 ErrorResponseBody Forbidden
404 ErrorResponseBody Resource not found
408 ErrorResponseBody Request timeout
500 ErrorResponseBody Internal server error
503 ErrorResponseBody Service unavailable
504 ErrorResponseBody Gateway timeout

Example response body

200 Response (AccessControlList)

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

Update OMF Connection Access Control List

Updates the AccessControlList for the specified OmfConnection.

Request

PUT /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/omfConnections/{omfConnectionId}/accesscontrol

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string omfConnectionId
OMF connection identifier.

Request Body

The updated AccessControlList

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

Response

Status Code Body Type Description
200 AccessControlList The updated AccessControlList
401 ErrorResponseBody Unauthorized
403 ErrorResponseBody Forbidden
404 ErrorResponseBody Resource not found
408 ErrorResponseBody Request timeout
415 ErrorResponseBody Unsupported media type
500 ErrorResponseBody Internal server error
503 ErrorResponseBody Service unavailable
504 ErrorResponseBody Gateway timeout

Example response body

200 Response (AccessControlList)

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

Access Control

List OMF Connection Access Rights

Gets a list of the CommonAccessRights to the specified OmfConnection for the requesting Identity.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/omfConnections/{omfConnectionId}/accessrights

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string omfConnectionId
OMF connection identifier.

Response

Status Code Body Type Description
200 Inline A list of CommonAccessRights
401 ErrorResponseBody Unauthorized
403 ErrorResponseBody Forbidden
404 ErrorResponseBody Resource not found
408 ErrorResponseBody Request timeout
500 ErrorResponseBody Internal server error
503 ErrorResponseBody Service unavailable
504 ErrorResponseBody Gateway timeout

Access Control

Get OMF Connection Owner

Gets the Trustee of the specified OmfConnectionId.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/omfConnections/{omfConnectionId}/owner

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string omfConnectionId
OMF connection identifier.

Response

Status Code Body Type Description
200 Trustee The Trustee
401 ErrorResponseBody Unauthorized
403 ErrorResponseBody Forbidden
404 ErrorResponseBody Resource not found
408 ErrorResponseBody Request timeout
500 ErrorResponseBody Internal server error
503 ErrorResponseBody Service unavailable

Example response body

200 Response (Trustee)

{
  "Type": 1,
  "ObjectId": "string",
  "TenantId": "string"
}

Update OMF Connection Owner

Updates the Trustee of the specified OmfConnection.

Request

PUT /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/omfConnections/{omfConnectionId}/owner

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

string omfConnectionId
OMF connection identifier.

Request Body

The updated Trustee

{
  "Type": 1,
  "ObjectId": "string",
  "TenantId": "string"
}

Response

Status Code Body Type Description
200 Trustee The updated Trustee
400 ErrorResponseBody Bad request
401 ErrorResponseBody Unauthorized
403 ErrorResponseBody Forbidden
404 ErrorResponseBody Resource not found
408 ErrorResponseBody Request timeout
415 ErrorResponseBody Unsupported media type
500 ErrorResponseBody Internal server error
503 ErrorResponseBody Service unavailable
504 ErrorResponseBody Gateway timeout

Example response body

200 Response (Trustee)

{
  "Type": 1,
  "ObjectId": "string",
  "TenantId": "string"
}

Access Control

Get OMF Connections Access Control List

Gets the AccessControlList for the OmfConnection collection.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/accesscontrol/omfConnections

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Response

Status Code Body Type Description
200 AccessControlList The AccessControlList
401 ErrorResponseBody Unauthorized
403 ErrorResponseBody Forbidden
404 ErrorResponseBody Resource not found
408 ErrorResponseBody Request timeout
500 ErrorResponseBody Internal server error
503 ErrorResponseBody Service unavailable
504 ErrorResponseBody Gateway timeout

Example response body

200 Response (AccessControlList)

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

Update OMF Connections Access Control List

Updates the AccessControlList for the OmfConnection collection.

Request

PUT /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/accesscontrol/omfConnections

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Request Body

The updated AccessControlList

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

Response

Status Code Body Type Description
200 AccessControlList The updated AccessControlList
400 ErrorResponseBody Bad request
401 ErrorResponseBody Unauthorized
403 ErrorResponseBody Forbidden
404 ErrorResponseBody Resource not found
408 ErrorResponseBody Request timeout
415 ErrorResponseBody Unsupported media type
500 ErrorResponseBody Internal server error
503 ErrorResponseBody Service unavailable
504 ErrorResponseBody Gateway timeout

Example response body

200 Response (AccessControlList)

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

Access Control

List OMF Connections Access Rights

Gets a list of the CommonAccessRights to the OmfConnection collection for the requesting Identity.

Request

GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/accessrights/omfConnections

Parameters

string tenantId
Tenant identifier.

string namespaceId
Namespace identifier.

Response

Status Code Body Type Description
200 Inline A list of CommonAccessRights
401 ErrorResponseBody Unauthorized
403 ErrorResponseBody Forbidden
404 ErrorResponseBody Resource not found
408 ErrorResponseBody Request timeout
500 ErrorResponseBody Internal server error
503 ErrorResponseBody Service unavailable
504 ErrorResponseBody Gateway timeout

Definitions

AccessControlList

Properties

Property Name Data Type Required Nullable Description
RoleTrusteeAccessControlEntries [AccessControlEntry] false true None
{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}


AccessControlEntry

Properties

Property Name Data Type Required Nullable Description
Trustee Trustee false true None
AccessType AccessType false false None
AccessRights int64 false false None
{
  "Trustee": {
    "Type": 1,
    "ObjectId": "string",
    "TenantId": "string"
  },
  "AccessType": 0,
  "AccessRights": 0
}


Trustee

Properties

Property Name Data Type Required Nullable Description
Type TrusteeType false false None
ObjectId string false true None
TenantId string false true None
{
  "Type": 1,
  "ObjectId": "string",
  "TenantId": "string"
}


TrusteeType

Enumerated Values

Property Value
User 1
Client 2
Role 3

AccessType

Enumerated Values

Property Value
Allowed 0
Denied 1

ErrorResponseBody

Properties

Property Name Data Type Required Nullable Description
OperationId string false true None
Error string false true None
Reason string false true None
Resolution string false true None
Parameters object false true None
{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "Parameters": {
    "property1": "string",
    "property2": "string"
  }
}


In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in