M2M-Clients | Subrite

M2M-Clients

Endpoints for M2M-Clients

ReferenceUpdated October 13, 2026View as Markdown

GET/api/v1/setting/m2m-clients

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema Examplearray of M2MClientResponseDto

8 top-level fieldsSelect an object to expand

scopesarray of M2MScopesRequired when parent is present4 fields
[].scopes
- sectionIdstringRequired when parent is presentField path: [].scopes[].sectionId
  Field details
  Allowed values: "member", "subscription", "consent", "push-subscription", "push-content", "content", "communication", "segment", "custom-order", "widget", "plans_and_products"
- sectionNamestringField path: [].scopes[].sectionName
- readPermissionbooleanRequired when parent is present

Schema Examplearray of M2MClientResponseDto

200 · application/json

[
  {
    "scopes": [],
    "name": "string",
    "description": "string",
    "isActive": true,
    "id": 0,
    "clientIdentifier": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "tokenSuffix": "string"
  }
]

Example · 12 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
messagestring
errorsarray of FieldErrorRequired7 fields
errors

Responses 500

Status200 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all M2m clients of a tenant (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/setting/m2m-clients \
  --header 'Authorization: Bearer <token>'

Try it

Create a new M2M client for a tenant#

POST/api/v1/setting/m2m-clients

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

SchemaCreateM2MClientRequestDto

4 top-level fieldsSelect an object to expand

namestringRequired
scopesarray of M2MScopesRequired3 required when the containing object is present4 fields
scopes
minItems: 1

GET/api/v1/setting/m2m-clients/scopes

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema Examplearray of M2MScopes

4 top-level fields

sectionIdstringRequired when parent is present

GET/api/v1/setting/m2m-clients/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema ExampleM2MClientResponseDto

DELETE/api/v1/setting/m2m-clients/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 200

This response has no body.

Responses 400

PATCH/api/v1/setting/m2m-clients/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleUpdateM2MClientRequestDto

4 top-level fieldsSelect an object to expand

namestringOptional

Responses

5 status codes

Responses 201

Status201 400 401 403 500application/json

Schema ExampleCreateM2MClientResponseDto

9 top-level fieldsSelect an object to expand

scopesarray of M2MScopesRequired4 fields
scopes
- sectionIdstringRequired when parent is presentField path: scopes[].sectionId
  Field details
  Allowed values: "member", "subscription", "consent", "push-subscription", "push-content", "content", "communication", "segment", "custom-order", "widget", "plans_and_products"
- sectionNamestringField path: scopes[].sectionName
- readPermissionbooleanRequired when parent is presentField path: scopes[].readPermission
- updatePermissionbooleanRequired when parent is presentField path: scopes[].updatePermission
namestringRequired
descriptionstringRequired
isActivebooleanRequired
idnumberRequired
clientIdentifierstringRequired
createdAtstring (date-time)Required
tokenSuffixstringRequired
tokenstringRequired

13 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleCreateM2MClientResponseDto

201 · application/json

{
  "scopes": [
    {}
  ],
  "name": "string",
  "description": "string",
  "isActive": true,
  "id": 0,
  "clientIdentifier": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "tokenSuffix": "string",
  "token": "<token>"
}

Example · 13 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 500application/json

Body validation failed, or the tenant already has a client with this name

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "alreadyExists"
messagestring

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all M2m clients of a tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 lines

Responses 500

Status201 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all M2m clients of a tenant (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/setting/m2m-clients \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "scopes": [
    {}
  ],
  "description": "string",
  "isActive": true
}'

Schema Examplearray of M2MScopes

200 · application/json

[
  {
    "sectionId": "member",
    "sectionName": "string",
    "readPermission": true,
    "updatePermission": true
  }
]

Example · 8 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all M2m clients of a tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleM2MClientResponseDto

200 · application/json

{
  "scopes": [
    {}
  ],
  "name": "string",
  "description": "string",
  "isActive": true,
  "id": 0,
  "clientIdentifier": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "tokenSuffix": "string"
}

Example · 12 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

The id is not an integer

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is present

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all M2m clients of a tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

m2mClientNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "m2mClientNotFound"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is present

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "m2mClientNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

Same fields as Get a M2M client of a tenant by id (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all M2m clients of a tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

m2mClientNotFound

Schema ExampleErrorResponse

Same fields as Get a M2M client of a tenant by id (404).

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "m2mClientNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema ExampleM2MClientResponseDto

Same fields as Get a M2M client of a tenant by id (200).

Schema ExampleM2MClientResponseDto

200 · application/json

{
  "scopes": [
    {}
  ],
  "name": "string",
  "description": "string",
  "isActive": true,
  "id": 0,
  "clientIdentifier": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "tokenSuffix": "string"
}

Example · 12 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

Body validation failed, the id is not an integer, or the new name is already taken

Schema ExampleErrorResponse

Same fields as Create a new M2M client for a tenant (400).

Schema ExampleErrorResponse

400 · application/json

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all M2m clients of a tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Responses 404

Status200 400 401 403 404 500application/json

m2mClientNotFound

Schema ExampleErrorResponse

Same fields as Get a M2M client of a tenant by id (404).

Schema ExampleErrorResponse

404 · application/json

Responses 500

Status200 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all M2m clients of a tenant (403).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/setting/m2m-clients/{id}' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "scopes": [
    {}
  ],
  "description": "string",
  "isActive": true
}'

errors

array of FieldError

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

{
  "messageCode": "m2mClientNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Get all M2m clients of a tenant#

Responses

Responses 200

Responses 401

Responses 403

Responses 500

Create a new M2M client for a tenant#

Request body

Get all M2m permission scopes#

Responses

Responses 200

Get a M2M client of a tenant by id#

Parameters

Responses

Responses 200

Delete a M2M client of a tenant#

Parameters

Responses

Responses 200

Responses 400

Update a M2M client of a tenant by id#

Parameters

Request body

Get all M2m clients of a tenant#

Responses

Responses 200

Responses 401

Responses 403

Responses 500

Create a new M2M client for a tenant#

Request body

Get all M2m permission scopes#

Responses

Responses 200

Get a M2M client of a tenant by id#

Parameters

Responses

Responses 200

Delete a M2M client of a tenant#

Parameters

Responses

Responses 200

Responses 400

Update a M2M client of a tenant by id#

Parameters

Request body

Responses

Responses 201

Responses 400

Responses 401

Responses 403

Responses 500

Responses 401

Responses 403

Responses 500

Responses 400

Responses 401

Responses 403

Responses 404

Responses 500

Responses 401

Responses 403

Responses 404

Responses 500

Responses

Responses 200

Responses 400

Responses 401

Responses 403

Responses 404

Responses 500