OAuth API documentation

https://consent.swisscom.com/

/c/oauth2

get

Used to obtain the authorization codes (OAuth 3-legged) or the access token (implicit 2-legged)

get

Used to obtain the authorization codes or the access token (implicit)

/o/oauth2

get post

Used for obtaining access token (authorization code grant), refreshing token, revoking token, obtaining token information.

get

Used for obtaining access token and sometimes also a refresh token with authorization code grant.

post

Used for obtaining access token and sometimes also a refresh token with authorization code, refresh token, or client credentials grant.

Used for obtaining access token and sometimes also a refresh token with authorization code, refresh token, or client credentials grant.

Headers

  • Authorization: required (string)

    Identifies the App with client_id and client_secret. They must be separated by colon and base64 encoded.

    Example:

    Basic cXdlcnR5OmFzZGY=

Body

Type: application/x-www-form-urlencoded

Form Parameters
  • grant_type: required (string)

    "authorization_code" to get access and refresh tokens with a code. "refresh_token" to get access and refresh tokens with a refresh token. "client_credentials" to get an access token with client credentials grant.

  • refresh_token: (string)

    Required if grant_type="refresh_token". The refresh token.

  • code: (string)

    Required if grant_type="authorization_code". The code obtained by the user after consent.

  • redirect_uri: (string)

    Required if grant_type="authorization_code". The redirect_uri parameter given as input during consent.

  • scope: (string)

    Space-separated list of scopes, if it is desired to grant less scopes than configured for the app.

HTTP status code 200

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object",
    "properties": {
        "access_token": {
            "description": "The Access Token.",
            "type": "string",
            "required":true
        },
        "refresh_token": {
            "description": "Refresh Token. Depends on configuration whether present. Never given out if client credentials grant type.",
            "type": "string",
            "required":false
        },
        "expires_in": {
            "description": "Time in seconds indicating for how long the access token will be valid.",
            "type": "string",
            "required":true
        },
        "token_type": {
            "description": "Token type. E.g., bearer",
            "type": "string",
            "required":true
        }
    }
}

Example:

{
    "access_token" : "2YotnFZFEjr1zCsicMWpAA",
    "refresh_token" : "tGzv3JOkF0XG5Qx2TlKWIA",
    "token_type" : "bearer",
    "expires_in" : "3600"
}

HTTP status code 400

Invalid parameter.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object" ,
    "properties": {
        "uuid": {
            "description": "The UUID of the client software",
            "type": "string",
            "required" : "false"
        },
        "status": {
            "description": "The http status code",
            "type": "string",
            "required": true
        },
        "code": {
            "description": "The error code",
            "type": "string",
            "required": true
        },
        "message": {
            "description": "The error message",
            "type": "string",
            "required": true
        },
        "detail": {
            "description": "The error detail",
            "type": "string",
            "required": false
        },
        "error": {
            "description": "The error, according to the OAuth 2.0 standard",
            "type": "string",
            "required": false
        }
    }
}

Example:

{
    "status": "400",
    "code": "INVALID_REFRESH_TOKEN",
    "message": "Refresh token is invalid.",
    "detail": "Refresh token is invalid, expired, revoked, was already refreshed, or was issued to another client.",
    "error": "invalid_grant"
}

HTTP status code 401

Invalid parameter.

Body

Type: application/json

Schema:

{
    "$schema": "http://json-schema.org/draft-03/schema",
    "type": "object" ,
    "properties": {
        "uuid": {
            "description": "The UUID of the client software",
            "type": "string",
            "required" : "false"
        },
        "status": {
            "description": "The http status code",
            "type": "string",
            "required": true
        },
        "code": {
            "description": "The error code",
            "type": "string",
            "required": true
        },
        "message": {
            "description": "The error message",
            "type": "string",
            "required": true
        },
        "detail": {
            "description": "The error detail",
            "type": "string",
            "required": false
        },
        "error": {
            "description": "The error, according to the OAuth 2.0 standard",
            "type": "string",
            "required": false
        }
    }
}

Example:

{
    "status": "401",
    "code": "INVALID_REFRESH_TOKEN",
    "message": "Refresh token is invalid.",
    "detail": "Refresh token is invalid, expired, revoked, was already refreshed, or was issued to another client.",
    "error": "invalid_grant"
}

HTTP status code 404

Not Found. The server has not found anything matching the Request-URI.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "404",
  "code": "INVALID_REQUEST_RESOURCE",
  "message": "The requested resource does not exist. Verify that the resource URI is correctly spelled.",
  "detail": ""
}

HTTP status code 405

Method Not Allowed. The resource is not accessible via the given method. For example, the client sent a POST request to a resource that only implements GET.

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "405",
  "code": "INVALID_REQUEST_METHOD",
  "message": "The resource is not accessible via the given method. Check the documentation or the Allow header for allowed methods.",
  "detail": ""
}

HTTP status code 415

The request has a media type which the server or resource does not support. Please set the Content-Type header with a value supported by the API (e.g. application/json).

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-03/schema",
  "type": "object" ,
  "properties": {
    "uuid": {
      "description": "The UUID of the client software",
      "type": "string",
      "required": false
    },
    "status": {
      "description": "The http status code, e.g. 400",
      "type": "string",
      "required": true
    },
    "code": {
      "description": "The error code, e.g. INVALID_PARAMETER",
      "type": "string",
      "required": true
    },
    "message": {
      "description": "The error message",
      "type": "string",
      "required": true
    },
    "detail": {
      "description": "The error detail",
      "type": "string",
      "required": false
    }
  }
}

Example:

{
  "status": "415",
  "code": "UNSUPPORTED_MEDIA_TYPE",
  "message": "The request entity has a media type which the server or resource does not support. Please set the Content-Type header with a value supported by the API (e.g. application/json).",
  "detail": ""
}

get

Used for obtaining information about an access or refresh token.

get

Used for obtaining information about an access or refresh token.

get

Used for revoking an access token.

get

Used for revoking an access token.