If the broker is protected by authentication, set `enable_public_badge_access` to true in the configuration to enable badges to be embedded in a markdown file. [![GDS API Adapters/Account API Pact Status](https://pact-broker.cloudapps.digital/pacts/provider/Account%20API/consumer/GDS%20API%20Adapters/latest/badge.svg)]()
GDS API Adapters version: branch-pact-artifacts
Date published: about 2 months ago

A pact between GDS API Adapters and Account API

Requests from GDS API Adapters to Account API

A delete-subscription request for 'wizard-news' given there is a valid user session, with a 'wizard-news' email subscription
A delete-subscription request for 'wizard-news' given there is a valid user session
A delete-user request
A delete-user request for 'the-subject-identifier' given there is a user with subject identifier 'the-subject-identifier'
A get-attributes request given there is a valid user session
A get-attributes request given there is a valid user session, with an attribute called 'email'
A get-user request given there is a valid user session
A match-user-by-email request for 'email@example.com' given there is a user with email address 'email@example.com'
A match-user-by-email request for 'email@example.com'
A put-subscription request for 'wizard-news' given there is a valid user session
A put-subscription request for 'wizard-news' given there is a valid user session, with a 'wizard-news' email subscription
A show-subscription request for 'wizard-news' given there is a valid user session, with a 'wizard-news' email subscription
A show-subscription request for 'wizard-news' given there is a valid user session
A sign-in request
A validation request given there is a valid OAuth response
A validation request given there is a valid OAuth response, with the redirect path '/some-arbitrary-path'
A validation request
An end-session request

Interactions

Given there is a valid user session, with a 'wizard-news' email subscription, upon receiving a delete-subscription request for 'wizard-news' from GDS API Adapters, with

{
  "method": "delete",
  "path": "/api/email-subscriptions/wizard-news",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/85.0.0 ()",
    "GOVUK-Account-Session": "logged-in-user-session"
  }
}

Account API will respond with:

{
  "status": 204
}

Given there is a valid user session, upon receiving a delete-subscription request for 'wizard-news' from GDS API Adapters, with

{
  "method": "delete",
  "path": "/api/email-subscriptions/wizard-news",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/85.0.0 ()",
    "GOVUK-Account-Session": "logged-in-user-session"
  }
}

Account API will respond with:

{
  "status": 404
}

Upon receiving a delete-user request from GDS API Adapters, with

{
  "method": "delete",
  "path": "/api/oidc-users/the-subject-identifier",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/85.0.0 ()"
  }
}

Account API will respond with:

{
  "status": 404
}

Given there is a user with subject identifier 'the-subject-identifier', upon receiving a delete-user request for 'the-subject-identifier' from GDS API Adapters, with

{
  "method": "delete",
  "path": "/api/oidc-users/the-subject-identifier",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/85.0.0 ()"
  }
}

Account API will respond with:

{
  "status": 204
}

Given there is a valid user session, upon receiving a get-attributes request from GDS API Adapters, with

{
  "method": "get",
  "path": "/api/attributes",
  "query": "attributes[]=email",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/85.0.0 ()",
    "GOVUK-Account-Session": "logged-in-user-session"
  }
}

Account API will respond with:

{
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "body": {
    "govuk_account_session": "user-session-id",
    "values": {
    }
  }
}

Given there is a valid user session, with an attribute called 'email', upon receiving a get-attributes request from GDS API Adapters, with

{
  "method": "get",
  "path": "/api/attributes",
  "query": "attributes[]=email",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/85.0.0 ()",
    "GOVUK-Account-Session": "logged-in-user-session"
  }
}

Account API will respond with:

{
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "body": {
    "govuk_account_session": "user-session-id",
    "values": {
      "email": "email@example.com"
    }
  }
}

Given there is a valid user session, upon receiving a get-user request from GDS API Adapters, with

{
  "method": "get",
  "path": "/api/user",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/85.0.0 ()",
    "GOVUK-Account-Session": "logged-in-user-session"
  }
}

Account API will respond with:

{
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "body": {
    "govuk_account_session": "user-session-id",
    "id": "user-id",
    "mfa": true,
    "email": "user@example.com",
    "email_verified": true
  }
}

Given there is a user with email address 'email@example.com', upon receiving a match-user-by-email request for 'email@example.com' from GDS API Adapters, with

{
  "method": "get",
  "path": "/api/user/match-by-email",
  "query": "email=email%40example.com",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/85.0.0 ()"
  }
}

Account API will respond with:

{
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "body": {
    "match": false
  }
}

Upon receiving a match-user-by-email request for 'email@example.com' from GDS API Adapters, with

{
  "method": "get",
  "path": "/api/user/match-by-email",
  "query": "email=email%40example.com",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/85.0.0 ()"
  }
}

Account API will respond with:

{
  "status": 404
}

Given there is a valid user session, upon receiving a put-subscription request for 'wizard-news' from GDS API Adapters, with

{
  "method": "put",
  "path": "/api/email-subscriptions/wizard-news",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/85.0.0 ()",
    "Content-Type": "application/json",
    "GOVUK-Account-Session": "logged-in-user-session"
  },
  "body": {
    "topic_slug": "wizard-news-topic-slug"
  }
}

Account API will respond with:

{
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "body": {
    "govuk_account_session": "user-session-id",
    "email_subscription": {
      "name": "wizard-news",
      "topic_slug": "wizard-news-topic-slug"
    }
  }
}

Given there is a valid user session, with a 'wizard-news' email subscription, upon receiving a put-subscription request for 'wizard-news' from GDS API Adapters, with

{
  "method": "put",
  "path": "/api/email-subscriptions/wizard-news",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/85.0.0 ()",
    "Content-Type": "application/json",
    "GOVUK-Account-Session": "logged-in-user-session"
  },
  "body": {
    "topic_slug": "wizard-news-topic-slug"
  }
}

Account API will respond with:

{
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "body": {
    "govuk_account_session": "user-session-id",
    "email_subscription": {
      "name": "wizard-news",
      "topic_slug": "wizard-news-topic-slug"
    }
  }
}

Given there is a valid user session, with a 'wizard-news' email subscription, upon receiving a show-subscription request for 'wizard-news' from GDS API Adapters, with

{
  "method": "get",
  "path": "/api/email-subscriptions/wizard-news",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/85.0.0 ()",
    "GOVUK-Account-Session": "logged-in-user-session"
  }
}

Account API will respond with:

{
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "body": {
    "email_subscription": {
      "name": "wizard-news",
      "topic_slug": "wizard-news-topic-slug"
    }
  }
}

Given there is a valid user session, upon receiving a show-subscription request for 'wizard-news' from GDS API Adapters, with

{
  "method": "get",
  "path": "/api/email-subscriptions/wizard-news",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/85.0.0 ()",
    "GOVUK-Account-Session": "logged-in-user-session"
  }
}

Account API will respond with:

{
  "status": 404
}

Upon receiving a sign-in request from GDS API Adapters, with

{
  "method": "get",
  "path": "/api/oauth2/sign-in",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/85.0.0 ()"
  }
}

Account API will respond with:

{
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "body": {
    "auth_uri": "http://authentication-provider/some/oauth/url",
    "state": "value-to-use-for-csrf-prevention"
  }
}

Given there is a valid OAuth response, upon receiving a validation request from GDS API Adapters, with

{
  "method": "post",
  "path": "/api/oauth2/callback",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/85.0.0 ()",
    "Content-Type": "application/json"
  },
  "body": {
    "code": "code",
    "state": "state"
  }
}

Account API will respond with:

{
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "body": {
    "govuk_account_session": "user-session-id"
  }
}

Given there is a valid OAuth response, with the redirect path '/some-arbitrary-path', upon receiving a validation request from GDS API Adapters, with

{
  "method": "post",
  "path": "/api/oauth2/callback",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/85.0.0 ()",
    "Content-Type": "application/json"
  },
  "body": {
    "code": "code",
    "state": "state"
  }
}

Account API will respond with:

{
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "body": {
    "govuk_account_session": "user-session-id",
    "redirect_path": "/some-arbitrary-path"
  }
}

Upon receiving a validation request from GDS API Adapters, with

{
  "method": "post",
  "path": "/api/oauth2/callback",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/85.0.0 ()",
    "Content-Type": "application/json"
  },
  "body": {
    "code": "code",
    "state": "state"
  }
}

Account API will respond with:

{
  "status": 401
}

Upon receiving an end-session request from GDS API Adapters, with

{
  "method": "get",
  "path": "/api/oauth2/end-session",
  "headers": {
    "Accept": "application/json",
    "User-Agent": "gds-api-adapters/85.0.0 ()"
  }
}

Account API will respond with:

{
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "body": {
    "end_session_uri": "http://authentication-provider/some/end/session/url"
  }
}