Supported Formats

JSON

GET api.dmarcreport.com/v2/accounts/:account_id/user_accounts
List user accounts

Supported Formats

JSON

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Not Found
500 Server crashed for some reason

Examples

{
    "account_owner_email": "abc@xyz.org",
    "user_accounts": [
        {
            "id": 6,
            "account_id": 1484,
            "user_id": 713,
            "domains": true,
            "alerts": true,
            "domains_reports": false,
            "plans": false,
            "profile": false,
            "reports": true,
            "subscription": false,
            "summary": true,
            "teams": true,
            "timeline": true,
            "widgets": true
        },
        {
            "id": 7,
            "account_id": 1484,
            "user_id": 1737,
            "domains": true,
            "alerts": true,
            "domains_reports": false,
            "plans": false,
            "profile": false,
            "reports": true,
            "subscription": false,
            "summary": true,
            "teams": true,
            "timeline": true,
            "widgets": true
        },
        {
            "id": 8,
            "account_id": 1484,
            "user_id": 49,
            "domains": true,
            "alerts": true,
            "domains_reports": false,
            "plans": false,
            "profile": false,
            "reports": true,
            "subscription": false,
            "summary": true,
            "teams": true,
            "timeline": true,
            "widgets": true
        }
    ]
}

GET api.dmarcreport.com/v2/accounts/:account_id/user_accounts/:id
Details of user account

Supported Formats

JSON

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Not Found
500 Server crashed for some reason

Examples

{
    "id": 8,
    "user_id": 49,
    "account_id": 13,
    "profile": false,
    "domains_reports": false,
    "subscription": false,
    "plans": false,
    "api_tokens": false,
    "domains": true,
    "summary": true,
    "timeline": true,
    "reports": true,
    "alerts": true,
    "teams": true,
    "widgets": true,
    "timestamp": null,
    "sso": false,
    "tag": false
}

POST api.dmarcreport.com/v2/accounts/:account_id/user_accounts.json
Add user in account

Supported Formats

JSON

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Not Found
500 Server crashed for some reason

Params

Param name Description
user_account
required

Validations:

  • Must be a Hash

user_account[email]
required

email of user, you want to add in account

Validations:

  • Must be a String

user_account[domains_reports]
required

domains_reports access flag

Validations:

  • Must be one of: true, false, true, false.

user_account[alerts]
required

alerts access flag

Validations:

  • Must be one of: true, false, true, false.

user_account[domains]
required

domains access flag

Validations:

  • Must be one of: true, false, true, false.

user_account[reports]
required

reports access flag

Validations:

  • Must be one of: true, false, true, false.

user_account[summary]
required

summary access flag

Validations:

  • Must be one of: true, false, true, false.

user_account[teams]
required

teams access flag

Validations:

  • Must be one of: true, false, true, false.

user_account[timeline]
required

timeline access flag

Validations:

  • Must be one of: true, false, true, false.

user_account[widgets]
required

widgets access flag

Validations:

  • Must be one of: true, false, true, false.

user_account[sso]
required

sso access flag

Validations:

  • Must be one of: true, false, true, false.

user_account[tag]
required

tag access flag

Validations:

  • Must be one of: true, false, true, false.


PUT api.dmarcreport.com/v2/accounts/:account_id/user_accounts/:id.json
Update user in account

Supported Formats

JSON

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Not Found
500 Server crashed for some reason

Params

Param name Description
user_account
required

Validations:

  • Must be a Hash

user_account[domains_reports]
optional

domains_reports access flag

Validations:

  • Must be one of: true, false, true, false.

user_account[alerts]
optional

alerts access flag

Validations:

  • Must be one of: true, false, true, false.

user_account[domains]
optional

domains access flag

Validations:

  • Must be one of: true, false, true, false.

user_account[reports]
optional

reports access flag

Validations:

  • Must be one of: true, false, true, false.

user_account[summary]
optional

summary access flag

Validations:

  • Must be one of: true, false, true, false.

user_account[teams]
optional

teams access flag

Validations:

  • Must be one of: true, false, true, false.

user_account[timeline]
optional

timeline access flag

Validations:

  • Must be one of: true, false, true, false.

user_account[widgets]
optional

widgets access flag

Validations:

  • Must be one of: true, false, true, false.

user_account[sso]
optional

widgets access flag

Validations:

  • Must be one of: true, false, true, false.

user_account[tag]
optional

widgets access flag

Validations:

  • Must be one of: true, false, true, false.


DELETE api.dmarcreport.com/v2/accounts/:account_id/user_accounts/:id.json
Delete user from account

Supported Formats

JSON

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Not Found
500 Server crashed for some reason