Update M2M Account

PUT 
/v2/account/:account_id/m2m-credentials

Patch an account’s M2M client secret or description.Requires accountOrg:config:edit or account:config:edit permissions and for user to share an org with the account.If rotate_secret is set to true, a new client secret will be generated.

Request

Path Parameters

account_id uuidrequired

Account ID

Query Parameters

rotate_secret Rotate Secret

application/json

Body

client_secret Client Secret (string)

Client secret for this account

description Description (string)

Description for this account

Responses

200

Successful Response

application/json

Schema

Schema

account_id uuidrequired

The client ID

client_secret Client Secret (string)required

The client secret for the M2M Account

description Description (string)

A description of the M2M Account

org_id uuid

The Org ID the M2M Account belongs to

Example (from schema)

{
  "account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "client_secret": "string",
  "description": "string",
  "org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...